El Java Los comentarios son declaraciones en un programa que no son ejecutadas por el compilador ni el intérprete.

¿Por qué utilizamos comentarios en un código?

• Los comentarios se utilizan para hacer que el programa sea más legible agregando los detalles del código.
• Facilita el mantenimiento del código y la búsqueda de errores fácilmente.
• Los comentarios se pueden utilizar para proporcionar información o explicación sobre el variable , método, clase , o cualquier declaración.
• También se puede utilizar para evitar la ejecución del código del programa mientras se prueba el código alternativo.

Tipos de comentarios Java

Hay tres tipos de comentarios en Java.

1. Comentario de una sola línea
2. Comentario de varias líneas
3. Comentario sobre la documentación

1) Comentario de una sola línea de Java

El comentario de una sola línea se utiliza para comentar solo una línea del código. Es la forma más sencilla y ampliamente utilizada de comentar las declaraciones.

Los comentarios de una sola línea comienzan con dos barras diagonales. (//) . Java no ejecuta ningún texto delante de //.

Sintaxis:

 //This is single line comment 

Usemos un comentario de una sola línea en un programa Java.

CommentExample1.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 } } 

Producción:

 10 

2) Comentario de varias líneas de Java

El comentario de varias líneas se utiliza para comentar varias líneas de código. Se puede utilizar para explicar un fragmento de código complejo o para comentar varias líneas de código a la vez (ya que será difícil utilizar comentarios de una sola línea allí).

Los comentarios de varias líneas se colocan entre /* y */. Java no ejecuta ningún texto entre /* y */.

Sintaxis:

img css alinear

 /* This is multi line comment */ 

Usemos comentarios de varias líneas en un 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 ); */ } } 

Producción:

 10 

Nota: Generalmente // se usa para comentarios cortos y /* */ se usa para comentarios más largos.

3) Comentario de la documentación de Java

Los comentarios de documentación generalmente se usan para escribir programas grandes para un proyecto o aplicación de software, ya que ayudan a crear una API de documentación. Estas API son necesarias como referencia, es decir, qué clases, métodos, argumentos, etc., se utilizan en el código.

Para crear una API de documentación, necesitamos usar el herramienta javadoc . Los comentarios de la documentación se colocan entre /** y */.

Sintaxis:

 /** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */ 

etiquetas javadoc

Algunas de las etiquetas comúnmente utilizadas en los comentarios de la documentación:

Usemos la etiqueta Javadoc en un programa Java.

Calculate.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(&apos;Addition of numbers: &apos; + result); } } </p>

Compílelo con la herramienta javac:

Crear documento

Crear API de documentación mediante javadoc herramienta:

Ahora, los archivos HTML se crean para el Calcular clase en el directorio actual, es decir, abcDemo . Abra los archivos HTML y podremos ver la explicación de la clase Calcular proporcionada a través del comentario de la documentación.

¿Son ejecutables los comentarios de Java?

Años: Como sabemos, los comentarios de Java no son ejecutados por el compilador o el intérprete; sin embargo, antes de la transformación léxica del código en el compilador, el contenido del código se codifica en ASCII para facilitar el procesamiento.

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } } 

Producción:

El código anterior genera el resultado porque el compilador analiza el carácter Unicode u000d como un nueva línea antes de la transformación léxica, por lo que el código se transforma como se muestra a continuación:

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } 

Por lo tanto, el carácter Unicode desplaza la declaración de impresión a la siguiente línea y se ejecuta como un código Java normal.