[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.

[Java] Componentes de uma classe na linguagem de programação Java

Os componentes de uma classe na linguagem de programação Java são:

• Declaração da classe.
• Declaração e inicialização de atributos (opcional).
• Métodos e construtores (opcional).
• Comentários (opcional)

Como já foi mensionado anteriormente sobre a sintaxe e exemplo da declaração de classe, atributos, métodoos e métodos construtores, neste post irei apenas falar sobre os comentários.

Comentários

Comentários são linhas escritas num código fonte que não serão compiladas/interpretadas e servem apenas para orientação, organização e explicações sobre o código de um programa. Em Java, comentários podem ser escritos de três formas diferentes: comentários de uma linha, múltiplas linhas e de documentação.

Exemplo de comentário de uma linha:

public int saldo = 0; // Saldo Inicial

Exemplo de comentário de múltiplas linhas:

/* CarregamentoERoteamento (int regiao)
 *
 * Método da heurística para busca de uma solução factível
 * para o problema de roteamento e carregamento dos
 * caminhões cegonha para uma região.
 */

Exemplo de comentário de documentação:

/**
* Valida um movimento de xadrez.
*
* @param colunaDe Coluna atual da peça a ser movida.
* @param linhaDe Linha atual da peça a ser movida.
* @param colunaPara Coluna destino da peça a ser movida.
* @param linhaPara Linha destino da peça a ser movida.
* @return Verdadeiro se o movimento é válido ou falso se inválido.
* @author João
* @author Maria
*/