Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DI-2673

O Cronapp possui uma ferramenta específica para gerar documentações automáticas a partir das implementações do sistema. É possível gerar documentações de 5 áreas do projeto: APIs, Blocos de programações (servidor e cliente), BPMN, Diagrama de dados e o Dicionário de dados.

Para criar ou atualizar as documentações existente, acesse no menu do sistema Projeto / > Gerar Documentação, selecione quais os recursos que deseja gerar e clique em OK.Image Removed


Image Added

Figura 1 - Ferramenta Gerar documentação


Após o processo, a documentação de cada recurso estará separada por pastas dentro do diretório Documentação (localização: /Documentação/ 

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: docs/

).

API

A opção API gera um arquivo *.pdf com todos os recursos OData disponíveis no sistema. Esse conteúdo estará disponível no diretório api (localização: Documentação/api

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: docs/api/

).Image Removed


Image Added

Figura 2 - Documentação das API's do sistema

Blocos de programação

Essa opção gera documentações em HTML a partir dos blocos de programação (Servidor e cliente) e das tags dos comentários inseridos no código. São divididas em 2 pastas: javadoc, para os blocos Servidor e jsdoc, para os blocos cliente. Por padrão, você não precisa se preocupar com as tags se estiver desenvolvendo em Low code, pois são geradas automaticamente, mas caso precise, ao ativar o Modo Avançado, poderá também incluir as tags do javadoc (para Servidor) e jsdoc (para cliente) no modo High code.

Acesse o subtópico Gerar Gerador de documentação em Bloco de programação para mais detalhes.

Servidor

A partir da página index (localização:  Documentação/Blocos de programação/javadoc/Blocos de programação/indexindex 

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: docs/blockly/javadoc/index.html

) é possível navegar por todos os recursos desenvolvidos no back-end da aplicação. Caso tenha dúvidas sobre as informações geradas pelo javadocs, acesse o link "HELP" no menu superior da documentação.

Image Removed


Image Added

Figura 3 - Documentação dos blocos de programação servidor

Cliente

A partir da página index global (localização:  Documentação/Blocos de programação/jsdoc/web/indexglobal 

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: docs/blockly/jsdoc/web/indexglobal.html

) é possível navegar por todas as funções desenvolvidas no front-end da aplicação.

Image Removed


Image Added

Figura 4 - Documentação dos blocos de programação cliente

BPMN

A opção BPMN gera arquivos *.pdf com todos os fluxos BPMN criados no sistema. Esse conteúdo estará disponível no diretório bpmn (localização: Documentação/bpmn

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: docs/bpmn/

).Image Removed


Image Added

Figura 5 - Documentação com as estruturas BPMN do sistema

Diagrama

A opção Dados gera arquivos *.svg com a estrutura do Diagrama de dados do sistema. Esse conteúdo estará disponível no diretório models (localização: Documentação/data/models

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: docs/data/models/

).Image Removed


Image Added

Figura 6 - Diagrama de dados do sistema

Dicionário de dados

A opção Dicionário de dados gera um arquivo *.HTML com a estrutura das classes do sistema. Esse conteúdo estará disponível no diretório dictionary (localização: Documentação/dictionary

Tooltip
onlyIcontrue
appendIconinfo-circle

Endereço: docs/dictionary/

). O dicionário é aberto em um editor de texto rico que permite personalizar o conteúdo antes de exportá-lo.Image Removed


Image Added

Figura 7 - Descrição das classes do sistema

Nesta página

Índice