Comentarios en Java

En un programa, los comentarios son como sangrías que uno hace, se usan para que sea más fácil para alguien que no está familiarizado con el lenguaje poder entender el código. También le facilitará el trabajo a usted, como codificador, para encontrar errores en el código, ya que podrá encontrar fácilmente la ubicación del error. El compilador ignora los comentarios mientras compila un código, lo que hace que el trabajo sea más complejo a largo plazo cuando tienen que pasar por tanto código para encontrar una línea.

En Java hay tres tipos de comentarios: 

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

A. Comentarios de una sola línea

Un programador de nivel principiante utiliza principalmente comentarios de una sola línea para describir la funcionalidad del código. Son los comentarios más fáciles de escribir.

Sintaxis:  

//Comments here( Text in this line only is considered as comment )

Ilustración: 
 

Ejemplos en un código real 

Ejemplo:

// Java program to show single line comments
 
class Scomment
{
    public static void main(String args[])
    {
         // Single line comment here
         System.out.println("Single line comment above");
    }
}

B. Comentarios de varias líneas:

Describir un método completo en un código o un fragmento complejo de comentarios de una sola línea puede ser tedioso de escribir, ya que tenemos que dar ‘//’ en cada línea. Entonces, para superar esto, se pueden usar comentarios de varias líneas. 

Sintaxis: 

/*Comment starts
continues
continues
.
.
.
Comment ends*/

Ejemplo:  

//Java program to show multi line comments
class Scomment
{
    public static void main(String args[])
    {
        System.out.println("Multi line comments below");
        /*Comment line 1
          Comment line 2
          Comment line 3*/
    }
}

También podemos lograr comentarios de una sola línea usando la sintaxis anterior como se muestra a continuación: 

/*Comment line 1*/

C. Comentarios sobre la documentación:

Este tipo de comentario se usa generalmente cuando se escribe código para un proyecto/paquete de software, ya que ayuda a generar una página de documentación como referencia, que se puede usar para obtener información sobre los métodos presentes, sus parámetros, etc. Por ejemplo, http:/ /docs.oracle.com/javase/7/docs/api/java/util/Scanner.html es una página de documentación generada automáticamente que se genera mediante el uso de comentarios de documentación y una herramienta javadoc para procesar los comentarios.

Sintaxis:  

/**Comment start
*
*tags are used in order to specify a parameter
*or method or heading
*HTML tags can also be used 
*such as <h1>
*
*comment ends*/

Etiquetas disponibles para usar: 

Implementación: 

// Java program to illustrate frequently used
// Comment tags
 
/**
* <h1>Find average of three numbers!</h1>
* The FindAvg program implements an application that
* simply calculates average of three integers and Prints
* the output on the screen.
*
* @author  Pratik Agarwal
* @version 1.0
* @since   2017-02-18
*/
public class FindAvg
{
    /**
    * This method is used to find average of three integers.
    * @param numA This is the first parameter to findAvg method
    * @param numB  This is the second parameter to findAvg method
    * @param numC  This is the second parameter to findAvg method
    * @return int This returns average of numA, numB and numC.
    */
    public int findAvg(int numA, int numB, int numC)
    {
        return (numA + numB + numC)/3;
    }
 
    /**
    * This is the main method which makes use of findAvg method.
    * @param args Unused.
    * @return Nothing.
    */
 
    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);
    }
}

Producción: 

Average of 10, 20 and 30 is :20

Para el código anterior, la documentación se puede generar utilizando la herramienta ‘javadoc’:

Javadoc se puede usar ejecutando el siguiente comando en la terminal.  

javadoc FindAvg.java

Este artículo es una contribución de Pratik Agarwal . Si te gusta GeeksforGeeks y te gustaría contribuir, también puedes escribir un artículo usando write.geeksforgeeks.org o enviar tu artículo por correo a review-team@geeksforgeeks.org. Vea su artículo que aparece en la página principal de GeeksforGeeks y ayude a otros Geeks.

Escriba comentarios si encuentra algo incorrecto o si desea compartir más información sobre el tema tratado anteriormente.