Enquanto o desenvolvedor estiver codificando ele irá inserir comentários no padrão de documentação Java e esses comentários serão a documentação feita no código do projeto, sendo o JAVADOC um compilado desses comentários por classes.

Ao gerar o JAVADOC serão compiladas todas as informações de todo o projeto e e elas ficarão disponíveis para que você, usuário, acesse e disponibilize como artefato do seu projeto.

Exemplo de um comentário no padrão de documentação Java:

/**
* Classe responsável iniciar a aplicação, por padrão ela executará as seguintes etapas:
* - Criar uma instância do ApplicationContext
* - Registrar um CommandLinePropertySource para expor argumentos como propriedades do Spring
* - Atualizar o contexto de aplicação para carregar os singletons
* - Executar qualquer bean do tipo CommandLineRunner
*/

O seu código está documentado?

Conheça o novo recurso de documentação da plataforma CronApp, nele serão compiladas todas as informações da criação de um projeto e elas ficarão disponíveis para que você, desenvolvedor, acesse e disponibilize como artefato do seu projeto.

Como isso funciona?

Enquanto você estiver codificando poderá inserir comentários em padrão Java no código de sua aplicação e esses comentários serão a documentação feita no código do projeto, sendo o JAVADOC um compilado desses comentários por classes.

Para conhecer mais sobre essa funcionalidade, acesse nossa documentação em: https://docs.cronapp.io/x/dYGEAQ


0 comentário

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *