O Java comentários são as instruções em um programa que não são executadas pelo compilador e interpretador.
Por que usamos comentários em um código?
- Comentários são usados para tornar o programa mais legível, adicionando detalhes do código.
- Facilita a manutenção do código e a localização fácil dos erros.
- Os comentários podem ser usados para fornecer informações ou explicações sobre o variável , método, aula , ou qualquer declaração.
- Também pode ser usado para impedir a execução do código do programa durante o teste do código alternativo.
Tipos de comentários Java
Existem três tipos de comentários em Java.
- Comentário de linha única
- Comentário multilinha
- Comentário sobre a documentação
1) Comentário de linha única Java
O comentário de linha única é usado para comentar apenas uma linha do código. É a maneira mais fácil e amplamente utilizada de comentar as afirmações.
Comentários de linha única começam com duas barras (//) . Qualquer texto antes de // não é executado por Java.
Sintaxe:
//This is single line comment
Vamos usar comentários de linha única em um programa Java.
ComentárioExemplo1.java
public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } } Saída:
10
2) Comentário Java Multilinha
O comentário de várias linhas é usado para comentar várias linhas de código. Ele pode ser usado para explicar um trecho de código complexo ou para comentar várias linhas de código por vez (pois será difícil usar comentários de uma única linha).
Comentários de múltiplas linhas são colocados entre /* e */. Qualquer texto entre /* e */ não é executado por Java.
Sintaxe:
bash verifica se a variável de ambiente está definida
/* This is multi line comment */
Vamos usar comentários multilinhas em um programa Java.
CommentExample2.java
public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } } Saída:
10
Nota: Normalmente // é usado para comentários curtos e /* */ é usado para comentários mais longos.
3) Comentário sobre a documentação Java
Comentários de documentação são geralmente usados para escrever programas grandes para um projeto ou aplicativo de software, pois ajudam a criar API de documentação. Essas APIs são necessárias para referência, ou seja, quais classes, métodos, argumentos, etc., são usados no código.
Para criar API de documentação, precisamos usar o ferramenta javadoc . Os comentários da documentação são colocados entre /** e */.
Sintaxe:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
tags javadoc
Algumas das tags comumente usadas em comentários de documentação:
| Marcação | Sintaxe | Descrição |
|---|---|---|
| {@docRoot} | {@docRoot} | para representar o caminho relativo para o diretório raiz do documento gerado em qualquer página. |
| @autor | @nome do autor - texto | Para adicionar o autor da classe. |
| @código | {@código texto} | Para mostrar o texto em fonte de código sem interpretá-lo como marcação html ou tag javadoc aninhada. |
| @versão | @version versão-texto | Para especificar o subtítulo 'Versão' e o texto da versão quando a opção -version é usada. |
| @desde | @desde o lançamento | Para adicionar o título 'Desde' com texto desde à documentação gerada. |
| @param | @param descrição do nome do parâmetro | Para adicionar um parâmetro com determinado nome e descrição à seção 'Parâmetros'. |
| @retornar | @return descrição | Obrigatório para todo método que retorna algo (exceto void) |
Vamos usar a tag Javadoc em um programa Java.
Calcular.java
import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println('Addition of numbers: ' + result); } } </p> Compile-o pela ferramenta javac:
Criar documento
Criar API de documentação por javadoc ferramenta:
Agora, os arquivos HTML são criados para o Calcular class no diretório atual, ou seja, abcDemo . Abra os arquivos HTML e poderemos ver a explicação da classe Calcular fornecida através do comentário da documentação.
Os comentários Java são executáveis?
Anos: Como sabemos, os comentários Java não são executados pelo compilador ou interpretador, porém, antes da transformação lexical do código no compilador, o conteúdo do código é codificado em ASCII para facilitar o processamento.
Teste.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } } Saída:
O código acima gera a saída porque o compilador analisa o caractere Unicode u000d como um nova linha antes da transformação lexical, e assim o código é transformado conforme mostrado abaixo:
Teste.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Assim, o caractere Unicode muda a instrução print para a próxima linha e é executada como um código Java normal.