Arquivo Discussoes de Programacao e Tecnologia Bom dia,
Estou com uma missão de fazer a documentação de uma aplicação web, tenho que apresentar alguma coisa, estou pensando em usar o Javadoc, o que vcs acham é rápido e simples ?
Tenho que escrever utilizando o Html puro ou existe algum recurso mais rápido ??
Obrigado
César
Cara é muito rápido e muito simples. Você faz a documentação no próprio código usando uma notação especial para comentários antes das classes variáveis e métodos, tal como:
/**
*Este é um comentario em javadoc
*@autor viniciusprd
*@version 1.0
*/
O resultado será uma página em html igual às paginas de api do java. Uma das vantagens do javadoc é que você mantem sempre a documentação do seu projeto atualizada com a documentação do seu codigo.
Obs: É mais fácil usar um IDE (NetBeans ou Eclipse) para fazer isto, pois eles dispõe de ferramentas que almentam e muinto a produtividade da documentação e você não precisa de ficar decorando as palavras chaves existentes no javadoc.