[Java] Usar comentários em um programa de origem

Comentários servem para organizar, documentar os programas e facilitar a leitura posterior. Como explicado anteriormente, existem três tipos de comentários que podem ser usados em um programa Java. Adicionalmente ao que já foi explicado, vale salientar que o comentário do tipo documentação é também chamado de Javadoc e após compilado produz um arquivo Html contendo a documentação escrita no comentário. Para que seja feito o javadoc, é necessário seguir as marcações pre-definidas que são:

Tag	Descrição
@author	Nome do desenvolvedor
@deprecated	Marca o método como deprecated. Algumas IDEs exibirão um alerta de compilação se o método for chamado.
@exception	Documenta uma exceção lançada por um método — veja também @throws.
@param	Define um parâmetro do método. Requerido para cada parâmetro.
@return	Documenta o valor de retorno. Essa tag não deve ser usada para construtores ou métodos definidos com o tipo de retorno void.
@see	Documenta uma associação a outro método ou classe.
@since	Documenta quando o método foi adicionado a a classe.
@throws	Documenta uma exceção lançada por um método. É um sinônimo para a @exception introduzida no Javadoc 1.2.
@version	Exibe o número da versão de uma classe ou um método.