Documentação de código com javadoc

javadoc é uma ferramenta para a criação de documentação de pacotes, classes, atributos e métodos Java a partir do processamento do código fonte com comentários em formato adequado.

Os comentários para javadoc devem ser iniciados por /** e encerrados por */, podendo incluir diretrizes sobre o que deve ser incluído na documentação gerada (em HTML).

Por default, documentação é gerada para classes e apenas para membros public ou protected.

Os comentários devem estar localizados imediatamente antes da definição da classe ou membro comentado. Cada comentário pode conter uma descrição textual sobre a classe ou membro, possivelmente incluindo tags HTML, e diretrizes para javadoc.

As diretrizes para javadoc são sempre precedidas por @, como em

• @see nomeClasseOuMembro: gera na documentação um link para a classe ou membro especificado, precedido pela frase "See also ".

A documentação de uma classe pode incluir as diretrizes:

• @author infoAutor: inclui informação sobre o autor na documentação.
• @version infoVersão: inclui informação sobre a versão na documentação.

A documentação de um método pode incluir as diretrizes:

• @param nome descrição para a descrição de argumentos.
• @return descrição para a descrição do valor de retorno.
• @exception nomeClasseExceção descrição para a descrição de exceções lançadas pelo método.

Para maiores informações, veja o texto How to Write Doc Comments for Javadoc.