Comentarios de bloque de Java

Aryan Tyagi 12 octubre 2023
Comentarios de bloque de Java

En Java, utilizamos comentarios para mejorar la legibilidad del código Java al proporcionar explicaciones e información adicionales sobre el código, lo que ayuda a mantener el código y encontrar errores y errores fácilmente. Al compilar el código java, el compilador excluye completamente el texto y las declaraciones dentro de los comentarios.

Discutiremos los comentarios de bloque en Java en este tutorial.

El comentario de bloque se utiliza para comentar muchas líneas de código al mismo tiempo. Usamos /* y */ para insertar comentarios de bloque. Los comentarios de bloque pueden extenderse a muchas líneas o insertarse dentro de una declaración de código. Solo el texto que se ve entre los delimitadores de comentarios se considera el comentario y no se tiene en cuenta durante la compilación.

Por ejemplo,

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);
  }
}

Producción :

7
3.14

Hay otro tipo de comentario de varias líneas disponible en Java. Para ello, utilizamos /** y */ para adjuntar los comentarios de la documentación. Esto se utiliza para definir API de documentación formal para sus programas que son creados por la herramienta javadoc. El javadoc es una herramienta que analiza las declaraciones y los comentarios de la documentación en una colección de archivos fuente y genera una colección de páginas HTML que describen las clases, interfaces, constructores, métodos y campos.

Por ejemplo,

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) {}
}

Cuando compilamos el código anterior con la herramienta javac, obtenemos javadoccomment.java, y luego se crea un archivo HTML para la clase javadoccomment. Abra el archivo HTML proporcionado y mire el comentario de la documentación de la clase javadoccomment.