Los comentarios en Java - FES Iztacala

Programas para aprender el lenguaje Java
4. Programa comentarios.java
Elementos a revisar
•
•
Concepto de comentario
Tipos de comentarios en Java
Los comentarios en Java
El código fuente de un programa en Java contiene instrucciones que van dirigidas
que la computadora haga algo. El caso de los comentarios es la excepción, pues los
comentarios son líneas en el código que no son instrucciones, son anotaciones que
el programador hace a manera de explicación de lo que se está haciendo. Los
comentarios se escriben en lenguaje natural, en nuestro caso el español. Un ejemplo
de comentario puede ser “Este programa se realizó como parte de la tesis de
licenciatura”.
Para escribir comentarios, es necesario el uso de los caracteres asterisco (*) y la
diagonal (/), en un acomodo específico que se explica a continuación y podrás
observar en el código fuente del programa de esta sección.
Hay tres tipos de comentarios en Java: comentarios tradicionales, de línea y de
documentación.
Comentarios tradicionales
Los comentarios tradicionales, que ya existían en el lenguaje C, se inician
con la secuencia de caracteres diagonal-asterisco (/*) y terminan con
asterisco-diagonal (*/). Pueden abarcar más de una línea. Todo lo que esté
encerrado entre esas dos marcas es un comentario. Por ejemplo:
/* Este programa es parte de la tesis de licenciatura
Facultad de Ciencias, UNAM
Agosto, 2008
*/
Miguel Murguía & Bernardo Serrano
13
Programas para aprender el lenguaje Java
Comentarios de una línea
Los comentarios de una línea, que al igual que los tradicionales ya existían
en el lenguaje C, se inician con dos caracteres de diagonal (//). El
comentario sólo ocupa una línea: desde donde comienza la marca //, y
termina al final de la línea. Por ejemplo:
// Este programa es parte de la tesis de licenciatura
Si se desea poner más líneas de texto como comentario, es necesario iniciar
una nueva línea de comentario, por ejemplo:
// Este programa es parte de la tesis de licenciatura
// Facultad de Ciencias, UNAM
Comentarios de documentación
Inician con las secuencia de tres caracteres diagonal-asterisco-asterisco: /**
y terminan con la secuencia de dos caracteres asterisco-diagonal */. Pueden
abarcar más de una línea, pero cada línea intermedia debe iniciar con
asterisco (*). Por ejemplo:
/**
*
*
*/
Este programa es parte de la tesis de licenciatura
Facultad de Ciencias, UNAM
Agosto, 2008
Los comentarios son parte importante del código fuente de un programa, pues
permiten hacer anotaciones en el código que facilitan la comunicación con otros
programadores, o bien para un mismo programador son útiles al recordar aspectos
particulares de cada porción del programa. Los comentarios son análogos a las notas
al margen que un lector hace en un libro. Como dato interesante se tiene el que ha
sido posible rastrear parte de la historia del español gracias a las anotaciones al
margen de un texto antiguo, las famosas Glosas emilianenses de finales del siglo X,
que son anotaciones en protoespañol al margen de textos en latín.
Los comentarios de documentación son introducidos en el lenguaje Java para
proporcionar una documentación automática del código del programa. Se utilizan en
combinación con el programa javadoc, que recopila todos los comentarios de
documentación y los asocia a elementos del programa que están en las líneas
inmediatas. En el ejercicio siguiente te explico más sobre este tipo de comentarios y
usarás el programa javadoc.
Código fuente
/* Miguel Murguía 31/Ago/2008
[email protected]
Facultad de Ciencias / FES Iztacala, UNAM 2008
*/
/**
*
Clase comentarios
*
Ejemplifica la salida a la pantalla mediante
Miguel Murguía & Bernardo Serrano
14
Programas para aprender el lenguaje Java
*
*
*
*
*/
System.out.println()
@author Miguel Murguía
@param args Lista de parámetros
@return nada No regresa valor
public class comentarios { // inicia la clase “hola”
public static void main(String[] args) {
/* la siguiente línea imprime
un mensaje en la pantalla */
System.out.println("¡ Bienvenida a Java !");
}
}
// fin de la clase “hola”
Descripción del programa
El programa presentado en este ejercicio es el mismo que el del ejercicio anterior,
únicamente le he añadido comentarios. Observa que el primer comentario, es un
comentario tradicional, que va encerrado entre los caracteres /* y */. El segundo es
un comentario de documentación, pues la primera línea inicia con /** y la última
línea con */, y las demás líneas del comentario inician con un asterisco.
El programa contiene además, comentarios de una línea, que inician con //.
Ejercicio 2.1: Añade comentarios
a un programa Java
1) Modifica el programa del ejercicio 1.1 añadiendo los comentarios que
consideres pertinentes.
2) Compila tu programa con el programa java. Puedes seguir los mismos pasos del
ejercicio 1.1
Autoevaluación
… Se cuáles son los tres tipos de comentarios en Java
… Puedo diferenciar en un código fuente de Java las líneas que son comentarios de
las que no lo son.
… Se agregar al código de un programa los tres tipos de comentarios
Miguel Murguía & Bernardo Serrano
15