Pergunta

Eu sei que um pode usar ' J' para criar etiquetas para um elemento de código único (método de classe, por exemplo).

Mas há uma maneira de criar automaticamente essas marcas para cada classe em todo o projeto? Ou mesmo apenas em pacote ou classe nível?

Foi útil?

Solução

Você já olhou para JAutodoc ?

Outras dicas

Não que eu saiba.

O que teria que ser bom de qualquer maneira? comentários Javadoc gerada automaticamente são piores do que inútil; Eu prefiro não tê-los atravancando o meu código e Javadoc irá fornecer o máximo de informações, mesmo sem comentário presente.

Automatic JavaDoc gerado é uma dor, porque outras pessoas nunca agora o que o método deve fazer e se também não vai conhecê-lo, quando você olha para a classe um ano depois.

Por favor, comente seus métodos por si mesmo ou não comentar o método.

Nossa empresa está usando checkstyle para forçar os empregadores a adicionar javadoc. Alguns empregadores odeio a comentar seus métodos e basta digitar comentários sensless. Seria melhor que a sua não é comentário do que um inútil.

Com checkstyle pode encontrar todos os métodos ilegais, para documentá-los em um formato bem.

O que vai ajudá-lo a documentar um método init como

"init tem de ser chamado antes de qualquer outro método e inicializa a classe ActionDummy "

é melhor dizer o que exatamente é feito

Inizializes o estado padrão da provedor de ação. Algumas variáveis ??de estado pode ser anulado pelo ouvinte quando ....

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top