Cómo comentar en Java?

Los comandos son muy importantes en la programación de computadoras. Estas son explicaciones simples del código fuente que hacen que el código fuente sea más comprensible para los humanos. Sin embargo, estos no son considerados por el compilador o el intérprete.

Importancia de los comentarios

Como se discutió anteriormente, los comentarios son necesarios porque hacen que un programa de computadora sea más comprensible. Los pros de los comentarios se enumeran a continuación.

• Hace que el código sea fácil de leer.
• Mantenimiento de código sin esfuerzo y detección de errores.
• Proporcionar detalles sobre un determinado método, clase, variable o declaración.
• Las funciones escritas para su uso por otros se vuelven más fáciles de entender.

Como en otros lenguajes de programación, también puedes escribir comentarios en Java. Este artículo explora varios tipos de comentarios de Java y cómo usarlos junto con sus ejemplos.

Tipos de comentarios de Java

En Java, hay tres enfoques para comentar como se muestra a continuación.

Comentario de una sola línea

Para comentar en una sola línea, se utilizan comentarios de una sola línea que comienzan con dos barras de avance. El texto escrito después de estas barras delanteras es ignorado por el compilador Java.

Aquí está la sintaxis del comentario de Java Single-Line:

// Este es un comentario de una sola línea

Ejemplo

Comentario múltiple

Cuando desee comentar varias líneas en su código fuente de Java, use un comentario de múltiples líneas. Comienza con / * y termina con * /. El texto escrito entre estos no será ejecutado por el compilador Java.

Sintaxis

/ * Este es un comentario de múltiples líneas */

Ejemplo

Comentario de documentación

Los comentarios de documentación generalmente se usan para crear API de documentación para programas Java más grandes. Estas API de documentación se utilizan para referencia a clases, métodos y argumentos utilizados en el código fuente. Comienza con /** y termina con* /.

Aquí está la sintaxis del comentario de tipo de documentación en Java.

/**
*
*Para representar los parámetros usamos varias etiquetas
*o método o encabezado
*O podemos usar etiquetas HTML
*
*/

Ejemplo

La tabla que se muestra a continuación cubre múltiples tipos de etiquetas Javadoc.

Nombre de la etiqueta	Sintaxis	Descripción
@autor	@Author Name-Text	Se usa para escribir el nombre del autor de una clase en particular.
@versión	@Version Version-Text	Se usa para mencionar el texto de la versión.
@param	@Descripción del nombre de parámetro parámetro	Se usa para agregar el nombre y la descripción del parámetro.
@devolver	@Descripción de @return	Se usa para encontrar los valores de retorno fácilmente haciendo una sección de "devoluciones".
@obsoleto	@Text desapedado de @	Se utiliza para indicar una clase o método desapercibido o se presenta y crea una advertencia cada vez que es utilizado por alguien.
@desde	@since liberación	Se utiliza para especificar la versión de método o clase, etc. agregando la sección "Desde".
@throws	@throws Descripción del nombre de clase	Se usa para lanzar una excepción.
@excepción	@Exception Class-Name Descripción	Tiene un uso similar al @throw etiqueta.
@ver	@See Reference	Se utiliza para agregar una referencia a un método o clase generando un enlace en la sección "Ver también".
@de serie	@Serial Field-Descripción | incluir | excluir	Se utiliza para agregar información relevante sobre campos serializados.
@Serialfield	@Serial Field-Name Type Field-Descripción de campo	Se usa para documentar el componente ObjectStreamField.
@serialdata	@SerialData Descripción de datos	Se utiliza para documentar datos escritos por métodos como WriteObject () o WriteExternal ().
@Docroot	@Docroot	Se usa para mostrar la ruta del directorio raíz.
@código	@@code text	Se usa para mostrar texto en fuentes de código.
@valor	@Value Paquete.clase#campo	Se usa para mostrar el valor de la constante cuando un comentario de doc se escribe en un campo estático.
@inheritdoc	-	Se usa para heredar un comentario de una clase heredable.
@enlace	@link paquete.Etiqueta de miembro de la clase##	Incluye un enlace que enfoca la documentación para un paquete, clase o nombre de miembro en particular de una clase a la que se remite.
@linklain	@linklain paquete.Etiqueta de miembro de la clase##	Similar al enlace con la única diferencia que la etiqueta del enlace se muestra en texto sin formato en lugar de texto de código.

Conclusión

Hay tres tipos de comentarios en Java. El primero es un comentario de una sola línea que comienza con dos barras delantera '//', el segundo es un comentario de múltiples líneas que comienza con/ * y termina con */, mientras que el último es un comentario de documentación que se usa para crear API de documentación para grandes programas y aplicaciones de Java. Todos estos tipos de comentarios se explican en este tutorial junto con etiquetas Javadoc que se utilizan en comentarios de documentación.