En Java, los comentarios son declaraciones no ejecutables que explican el código y mejoran la legibilidad. El compilador los ignora y no afectan la ejecución del programa.

• Mejore la legibilidad y el mantenimiento del código.
• Útil para depurar y documentar la lógica.

Java admite tres tipos principales de comentarios:

1. Comentarios de una sola línea

Los comentarios de una sola línea se utilizan para comentar una línea de código.

Sintaxis:   

// Comentarios aquí (solo el texto de esta línea se considera comentario)

// Java program to show single line comments class GFG {  public static void main(String args[])  {   // Single line comment here  System.out.println('Single Line Comment Above');   } } 

Single Line Comment Above 

2. Comentarios de varias líneas

Los comentarios de varias líneas se utilizan para describir códigos o métodos complejos, ya que escribir varios comentarios de una sola línea puede resultar tedioso.

/*
Comienza el comentario
continúa
continúa...
El comentario termina
*/

class GFG {  public static void main(String args[])  {   System.out.println('Multi Line Comments Below');    /* Comment line 1  Comment line 2   Comment line 3  */  } } 

Multi Line Comments Below 

3. Comentarios sobre la documentación

Los comentarios de documentación se utilizan para generar documentación externa utilizando Javadoc. Generalmente se utilizan en proyectos profesionales para describir métodos y parámetros de clases.

Sintaxis:   

/**
* Inicio del comentario
* @param descripción del nombre del parámetro
* @descripción de retorno
*/

/**  *   * Calculates the average of three integers.  * @author Pratik Agarwal  * @version 1.0  * @since 2017-02-18  */ public class FindAvg{  /**  * Finds average of three integers.  * @param numA First parameter  * @param numB Second parameter  * @param numC Third parameter  * @return Average of numA numB and numC  */  public int findAvg(int numA int numB int numC)  {  return (numA + numB + numC) / 3;  }  /**  * Main method which uses findAvg method  * @param args Unused  */  public static void main(String args[]){  FindAvg obj = new FindAvg();  int avg = obj.findAvg(10 20 30);  System.out.println('Average of 10 20 and 30 is: '  + avg);  } } 

Average of 10 20 and 30 is: 20 

Artículo relacionado: herramienta JavaDoc

img css alinear