Texto que se
escribe entremezclado con el código fuente pero que, a diferencia de éste, no
está destinado a la máquina, sino a las personas que lean el código fuente. El
objetivo de los comentarios es facilitar a las personas la comprensión del
código, así como aportar información adicional tal como el nombre del autor,
fechas relevantes, propiedad intelectual, etc.
En java hay
·
comentarios
de una línea que comienzan con los caracteres "//" y terminan con la
línea
// Comentario en una sola línea.
·
comentarios
de un bloque de líneas que comienzan con los caracteres "/*" y
terminan con los caracteres "*/"
/*
* Comentario que ocupa varias líneas
* de forma que el autor se puede explayar.
*/
û estos comentarios no se pueden anidar:
comentarios dentro de comentarios
·
comentarios
para generación automática de documentación que comienzan con los caracteres
"/**" y terminan con los caracteres "*/. En estos comentarios,
algunas líneas tienen una interpretación especial a fin de generar la
documentación pertinente.
/**
* Ejemplo: círculos.
* @author José A. Mañas <jmanas@dit.upm.es>
* @version 24.9.2004
*/
estos
comentarios no se pueden anidar: (es decir, no pueden haber comentarios dentro
de otros comentarios)
Véase “Documentación”
Temas relacionados