Há duas formas de incluir comentários em um arquivo
Java.
O javadoc processa apenas comentários de documentação para
membros de classe declarados como public ou protected. Comentários em membros
do tipo private ou friendly serão ignorados, se não forem explicitados no
comando javadoc.
Há duas maneiras de se trabalhar com o
javadoc:
embutindo-se código HTML;
usando tags de
documentação.
Antes de metodos, construtores, campos de dados e classes, o
comentario de bloco iniciado com /** pode ser usado para gerar HTML em
documentacao.
A ferramenta (JavaDoc) que gera
automaticamente documentacao a partir dos arquivos .java relaciona e descreve
classes, metodos, etc e cria referencias
cruzadas.
Descricoes em HTML podem ser incluidas nos
comentarios especiais /**...*/