Tutorial de Java - 2 - Comentarios

 Java tiene comentarios que se utilizan para documentar las Clases, los methods (métodos) y procedimientos o rutinas dentro de las clases de Java estos son llamados comments (comentarios).

Tutorial de Java lección 2 - Comment (Comentarios)

Los comments (comentarios) son una parte muy común de las Clases de java y los vas a encontrar en los códigos fuentes de los programas.

Los comentarios son líneas de código que no se ejecutan y tampoco afectan al programa pues no se ejecutan, su propósito es el de informar al desarrollador sobre las Clases, los methods (métodos), etc. Esa información hace que los comments (comentarios) nos ayudan a que el código sea más fácil de leer y comprender. Es por eso que se recomienda que documentamos las clases con los comments (comentarios) y la verdad espero que los uses y agregues la documentación de tus clases, piensa en los que van a darle mantenimiento a tu código.

Tipos de comments (comentarios)

En java hay tres tipos de comentarios que puedes encontrar dentro de las clases, estos son:

El Single-line comment (comentarios de una sola línea): Estos comentarios solo son de una sola linea, y para indicar que se utilizara este tipo de comentario se utilizan dos caracteres de barra (slash) "/", y todo lo que se escribe después es el comentario.

// Comentario de una sola línea, hasta el final de la línea.

El Multiple-line comment (comentarios de múltiples líneas): Estos comentarios inician con los caracteres de barra (slash) seguido de un asterisco (asterisk) "/*", y todo lo que hay después incluyendo saltos de línea son considerados comentarios, hasta que encuentra el cierre que un asterisco (asterisk) seguido por una barra (slash) "*/".

/* Comentario 
* de
* líneas múltiple */

Por último tenemos el Javadoc comment (comentarios para Javadoc): Este comment (comentario) es similar al Multiple-line comment (comentarios de múltiples líneas) pero este inicia con una barra (slash) seguido por dos asteriscos (asterisks) "/**" y serán tomado todo lo que esté a la derecha como un comentario hasta que se encuentre un "*/".

/**
* Javadoc comentario de múltiples líneas
* @author Squirrel Programming
*/

Javadoc tiene una estructura que la herramienta de Javadoc sabe como leer e interpretar, se recomienda leer la documentación de javadoc de Oracle para aprender más sobre este tema.

Saludos y feliz aprendizaje.