Comentarios en Java

En el código fuente de un programa escrito en Java se pueden escribir comentarios que no afectarán a su ejecución, ya que, al compilar no serán tenidos en cuenta. Pero, dichos comentarios sí ayudarán a describir y comprender mejor el funcionamiento del programa.

En Java, los comentarios se pueden clasificar en dos tipos:

• Comentarios de implementación.
• Comentarios de documentación.

Comentarios de implementación en Java

Los comentarios de implementación se utilizan para explicar el código fuente del programa. Para ello, se pueden utilizar los caracteres:

• // para comentar una línea, o parte de una línea hasta el final.
• /* y */ para delimitar un comentario en varias líneas.

EJEMPLO { HolaMundo } Programa "HolaMundo.java" incluyendo cuatro comentarios de implementación:

public class HolaMundo
{
    public static void main(String[] args)  // Signatura
    {
        // Invocación al método println
        System.out.println("¡Hola mundo!"); // Sentencia

        /* Al ejecutarse println, en la consola
         * se visualizará el mensaje: "¡Hola mundo!"
         */
    }
}

Comentarios de documentación en Java

En Java, los comentarios de documentación se utilizan para describir las clases. Para ello, se utilizan los caracteres /** y */.

EJEMPLO { HolaMundo } Programa "HolaMundo.java" incluyendo dos comentarios de documentación, además de los cuatro comentarios de implementación vistos en el ejemplo anterior:

/**
 * Clase HolaMundo. Ejemplo del Tutorial de Abrirllave
 * 
 * @author Carlos Pes
 */
public class HolaMundo
{
    /**
     * Método main
     */
    public static void main(String[] args) // Signatura
    {
        // Invocación al método println
        System.out.println("¡Hola mundo!"); // Sentencia

        /* Al ejecutarse println, en la consola
         * se visualizará el mensaje: "¡Hola mundo!"
         */
    }
}