Comentários do bloco Java

Em Java, usamos comentários para melhorar a legibilidade do código Java, fornecendo explicações e informações adicionais sobre o código, ajudando assim a manter o código e localizar bugs e erros facilmente. Ao compilar o código java, o compilador exclui completamente o texto e as instruções nos comentários.

Discutiremos comentários de bloco em Java neste tutorial.

O comentário de bloco é usado para comentar várias linhas de código ao mesmo tempo. Usamos /* e */ para inserir comentários de bloqueio. Os comentários do bloco podem se estender a várias linhas ou ser inseridos em uma instrução de código. Apenas o texto visto entre os delimitadores de comentário é considerado a observação e é desconsiderado durante a compilação.

Por exemplo,

public class multilinecomment {
  public static void main(String[] args) {
    /* we have declared an integer n having value 007
    and a floating point variable z
    storing value of pi. */
    int n = 007;
    double z = 3.14;
    System.out.println(n);
    System.out.println(z);
  }
}

Produção:

7
3.14

Existe outro tipo de comentário multilinha disponível em Java. Para isso, usamos /** e */ para incluir comentários de documentação. Isso é usado para definir APIs de documentação formal para seus programas que são criados pela ferramenta javadoc. O javadoc é uma ferramenta que analisa as declarações e comentários da documentação em uma coleção de arquivos de origem e gera uma coleção de páginas HTML que descrevem as classes, interfaces, construtores, métodos e campos.

Por exemplo,

public class javadoccomment {
  /**  multi() method returns multiplication of numbers.*/
  public static int multi(int a, int b) {
    return a * b;
  }

  /**  addition() method returns addition of numbers.*/
  public static int addition(int a, int b) {
    return a + b;
  }

  /**  subtract() method returns subtraction of numbers.*/
  public static int subtract(int a, int b) {
    return a - b;
  }
  public static void main(String[] args) {}
}

Quando compilamos o código fornecido acima pela ferramenta javac, obtemos javadoccomment.java e, em seguida, um arquivo HTML é criado para a classe javadoccomment. Abra o arquivo HTML fornecido e veja o comentário da documentação da classe javadoccomment.