Comentarios en Java

Un comentario es un texto que se escribe dentro de un programa con el fin de facilitar la comprensión del mismo. 
Los comentarios se utilizan para explicar y documentar el código fuente. 

En Java se pueden utilizar tres tipos de comentarios:

Comentario tradicional

Los comentarios tradicionales son los mismos que se usan en C. 
Las características de los comentarios tradicionales en Java son las siguientes:

• Empieza con los caracteres /* y acaba con */.
• Pueden ocupar más de una línea y pueden aparecer en cualquier lugar donde pueda aparear un espacio en blanco. 
• No pueden anidarse.

Ejemplos de comentarios tradicionales estilo C:

/* Programa Ecuación segundo grado
   Calcula las soluciones de una ecuación de segundo grado */

/* Lectura de datos por teclado */

Ejemplo de comentario no válido:

/* linea comentario 1
            /* linea comentario 2
               linea comemtario 3
            */
            linea comentario 4
            linea comentario 5
*/

Comentario no válido. Los comentarios no se pueden anidar.

Comentarios de una sola línea

Las características de los comentarios de una línea son las siguientes:

• Comienzan con una doble barra ( // ) 
• Pueden escribirse al principio de la línea o a continuación de una instrucción.
• No tienen carácter de terminación. 

Ejemplos de comentarios Java de una sola línea:

// Programa Ecuación segundo grado

// Calcula las soluciones de una ecuación de segundo grado

double p; // precio del producto

Comentarios de documentación Javadoc

Son comentarios especiales para generar documentación del programa.

Comienza con /** y termina con */

Ejemplo de comentario de documentación Javadoc:

/**
 *
 * @author Enrique
 * @version 2.0
 *
 */