Gerar Comentarios JAVADOC Automaticamente

5 respostas
S

Pessoal,

entrei há algum tempo para um projeto na faculdade no qual estamos desenvolvendo um software (INSANE - www.insane.dees.ufmg.br/websvn) de codigo livre para analise estrutural.

o problema é o seguinte: nunca tivemos a preocupação de documentar as classes. e agora que o projeto está tomando maiores proporções (com participação de outras universidades federais), os novos colaboradores estão tendo grande dificuldade em entender o projeto justamente pela pouca documenteção.

encontrei uma indicação de um plugin (CheckStyle) para o Eclipse aqui no forum. mas gostaria de receber dicas sobre como gerar comentarios JAVADOC automaticamente para todo o projeto para com isso facilitar a documentação.

Alguem sabe como gerar comentarios JAVADOC automaticamente para todo o projeto?

Luiz Henrique

5 Respostas

ddduran

você quer gerar o JAVADOC ou quer percorrer todas as suas classes e colocar o comentario encima dos metodos?

se for o primeiro o eclipse faz para você

se for o segundo não sei como fazer e não acho que um Javadoc sem nenhuma descrição seria util, mas se você colocar /** e dar enter ele monta a estrutura minima para você

S

quero percorrer todas as classes e colocar o comentario em cima dos metodos.

isso já seria de grande ajuda, pois fazer isso manualmente para cada metodo seria um trabalho adicional e braçal que gostaria não ter que fazer. assim, o formato da documentação já estaria pronta e o programador teria que somente preenche-la.

ddduran

então se ele vai ter que preencher de qualquer jeito é só chegar antes do metodo, classe, etc e digitar /** e dar enter o eclipse vai montar para você

você ainda pode configurar algumas preferencias nos templates do eclipse e algumas regras

felipealbuquerque

Você pode usar o UltraEdit para gerar comentários automaticamente.

Dá uma pesquisada nesse editor! :smiley:

S

felipe,

dei uma olhada nesse UltraEdit e vi que é pago.

a proposta do nosso projeto é ser opensource desenvolvido com softwares livres.

mas valeu pela dica.

LH

Criado 12 de novembro de 2007
Ultima resposta 12 de nov. de 2007
Respostas 5
Participantes 3