Comentarios en Java

Los comentarios en el código fuente en java, al igual que en el resto de lenguajes de programación no aparecen en el programa ejecutable,

Tipos de comentarios

Comentario hasta final de línea:

Cualquier texto incluido entre los caracteres /* y */ sera interpretado como un comentario y puede extenderse a través de varias lineas.

int a; // declaramos la variable "a" como un entero

Comentario multilínea:

Cualquier texto incluido entre los caracteres /* y */ sera interpretado como un comentario y puede extenderse a traves de varias lineas

/* Ejemplo de :
Como incluir un comentario
multilinea
*/

Comentario de documentación

Este permite generar automáticamente la documentación del código. Emplea un /** y */ para terminar

Java tiene una herramienta muy util llamada javadoc, que genera automáticamente documentación en formato HTML a partir de los ficheros de código fuente. La utilidad javadoc extrae información relativa a los elementos siguientes:

• paquetes
• clases e intefaces publicas
• Métodos públicos y protegidos
• Atributos públicos y protegidos

Estos comentarios contienen testo en formato libre seguido de ciertos marcadores , la primera frase del comentario debe ser una frase que aporte un resumen.

Los marcadores que podemos incluir en los comentarios de javadoc son:

• @param descripcion de variable
• @return descripción
• @throws descricion de la clase
• @author nombre
• @version texto
• @since texto
• @deprecated texto

Para mas información sobre JavaDoc visitar la web de oracle : Ver documentación