É possível obter avisos do javadoc quando algo perdido no javadoc-comments?

Question

Acidentalmente eu pode esquecer de descrever alguns parâmetros ou arremesso exceção (ou outra coisa) ao documentar métodos ou classes, etc.

É possível executar javadoc de tal maneira a que ele me avisa sobre a falta de itens de documentação?

(eu uso script ant para documentação de geração)

Answer 1

Use Checkstyle ! Tem Formiga impressionante de integração e suporta 100s de outras verificações importantes para o seu código fonte também.

O JavadocType verificador é o que você precisa embora.

Answer 2

Eu não sei de nenhuma opção javadoc que irá emitir um aviso sobre itens não-documentados.

No entanto, se acontecer de você usar o Eclipse, dê uma olhada nas configurações

Janela -> Preferências -> Java -> Compiler -> Javadoc

Não, você pode dizer o Eclipse para emitir alertas em itens sem documentos.

Answer 3

Doc check Doclet para um projeto anterior. Ele pode ser integrado com a construção e gera relatórios úteis que lhe dizem que código tem documentação pobre.

NOTA:. A ferramenta é beta e não mais suportada pela Sun

Answer 4

Sim, é, em Eclipse você tem cheque incorporar para tudo o que você definir, por isso, é possível colocar esta faltando em "avisos" e do que você vai e capaz de ver onde você cometer erros.