Como comentar em java?

Os comandos são muito importantes na programação de computadores. Essas são explicações simples do código -fonte que tornam o código -fonte mais compreensível para os humanos. No entanto, estes não são considerados pelo compilador ou pelo intérprete.

Importância dos comentários

Como discutido acima, os comentários são necessários porque tornam um programa de computador mais compreensível. Prós dos comentários estão listados abaixo.

• Facilita a leitura do código.
• Manutenção de código sem esforço e detecção de erros.
• Fornecer detalhes sobre um determinado método, classe, variável ou declaração.
• Funções escritas para uso por outras pessoas se tornam mais fáceis de entender.

Como em outras linguagens de programação, você também pode escrever comentários em java. Esta redação explora vários tipos de comentários de Java e como usá-los junto com seus exemplos.

Tipos de comentários de java

Em Java, há três abordagens para comentar como mostrado abaixo.

Comentário de linha única

Para comentar em uma única linha, são usados ​​comentários de linha única que começam com duas barras para a frente. O texto escrito após essas barras para a frente é ignorado pelo compilador Java.

Aqui está a sintaxe do comentário de linha única Java:

// Este é um comentário de linha única

Exemplo

Comentário de várias linhas

Quando você deseja comentar várias linhas em seu código-fonte Java, use um comentário de várias linhas. Começa com / * e termina com * /. O texto escrito entre eles não será executado pelo compilador Java.

Sintaxe

/ * Este é um comentário de várias linhas */

Exemplo

Comentário da documentação

Os comentários de documentação geralmente são usados ​​na criação da API de documentação para programas Java maiores. Essas APIs de documentação são usadas para fazer referência a classes, métodos e argumentos usados ​​no código -fonte. Começa com /** e termina com* /.

Aqui está a sintaxe do comentário do tipo de documentação em java.

/**
*
*Para representar parâmetros, usamos várias tags
*ou método ou cabeçalho
*Ou podemos usar tags html
*
*/

Exemplo

A tabela dada abaixo cobre vários tipos de tags javadoc.

Nome da tag	Sintaxe	Descrição
@autor	@Author Name-texto	É usado para escrever o nome do autor de uma determinada classe.
@versão	@Version Version-text	É usado para mencionar o texto da versão.
@param	@param-parâmetro Nome Descrição	É usado para adicionar nome e descrição do parâmetro.
@retornar	@return Descrição	É usado para encontrar os valores de retorno facilmente, fazendo uma seção "Retornos".
@descontinuada	@Deprecated Deprecated Text	É usado para indicação de uma classe ou método depreciado ou arquivado e cria um aviso toda vez que é usado por alguém.
@desde	@SENCIE RELEMENTO	É usado para especificar a versão do método ou classe etc. adicionando a seção "Desde".
@throws	@throws classe-name Descrição	É usado para jogar uma exceção.
@exceção	@Exception Classe-Name Descrição	Tem um uso semelhante ao @throw tag.
@ver	@See Referência	É usado para adicionar uma referência a um método ou classe, gerando um link na seção "Veja também".
@serial	@Serial Field-Description | incluir | excluir	É usado para adicionar informações relevantes sobre campos serializados.
@SerialField	@Serial Field-Nome de campo de campo de campo	É usado para documentar o componente ObjectStreamfield.
@SerialData	@SerialData Dados-descrição	É usado para documentar dados escritos por métodos como WriteObject () ou WriteExternal ().
@docroot	@docroot	É usado para mostrar o caminho do diretório raiz.
@código	@code text	É usado para exibir texto em fontes de código.
@valor	pacote @value.Classe#Campo	É usado para exibir o valor da constante quando um comentário do documento é escrito em um campo estático.
@IritDoc	-	É usado para herdar um comentário de uma classe herdável.
@link	pacote @link.Rótulo de membro da classe#	Inclui um link que focaliza a documentação para um pacote, classe ou nome de membro específico de uma classe que é referenciada.
@linkplain	@linkplain pacote.Rótulo de membro da classe#	Semelhante ao link com a única diferença de que o rótulo do link é exibido em texto simples, em vez de texto de código.

Conclusão

Existem três tipos de comentários em java. O primeiro é um comentário de linha única que começa com duas barras para a frente '//', o segundo é um comentário de várias linhas que começa com/ * e termina com */, enquanto o último é um comentário de documentação usado para criar API de documentação para grandes programas e aplicativos Java. Todos esses tipos de comentários são explicados neste tutorial, juntamente com tags javadoc que são usadas nos comentários da documentação.