Los programas contienen comentarios en los que establecemos el propósito del programa, explicamos el significado del código y proporcionamos cualquier otra descripción que ayude a los programadores a entender el programa cuando se realizan las tareas de depuración y mantenimiento de los mismos.
En Java tenemos tres tipos de comentarios:
- de una sola línea o de fin de línea
- de bloque o tradicionales, y
- javadoc
Un comentario que empieza con // se llama comentario de fin de línea (o de una sola línea), ya que termina al final de la línea que aparece. Si el texto a comentar es demasiado corto para que quepa en una sola línea, se deben utilizar comentarios de una sola línea. Por ejemplo:
//Este es un comentario
//Este es otro comentario
//Este es un tercer comentario
El compilador ignora todo desde la primera diagonal hasta el final de la línea.
Si el texto del comentario es demasiado largo para ponerlo en una sola línea, ponemos el comentario de múltiples líneas también conocido como comentario tradicional. Los comentarios de múltiples líneas inician con los símbolos /* y terminan con los de cierre */. Por ejemplo:
/*
Este es un comentario con
tres líneas de
texto
*/
El compilador ignora todo desde la primera diagonal hasta el final de la línea.
Java también cuenta con comentarios javadoc, que están delimitados por /** y */. Gracias a este tipo de comentarios y a la herramienta javadoc, es posible generar automáticamente una documentación del código fuente en forma de páginas HTML. Este documento muestra para cada clase: la jerarquía de las clases, las variables públicas y los métodos dentro de la clase. Por ejemplo:
1 /**
2 * Saludo.java
3 * Programa que imprime una línea de texto
4 * @author ProfesorJava
5 * @versión 1.0
6 * @created Noviembre 2010
7 */
8 public class Saludo
9 {
10 /*
11 * el método main empieza la ejecución de
12 * la aplicación de Java
13 */
14 public static void main( String[] args )
15 {
16 System.out.println( "Bienvenidos al Webinar Java." );
17 } //fin del método main
18 } //fin de la clase Saludo
El programa ilustra el uso de los tres tipos de comentarios en Java. La documentación generada con la herramienta javadoc sería similar a:
Bibliografía consultada:
- Como programar en Java, Deitel & Deitel, pág. 36, Séptima Edición 2008, Editorial Pearson Education.
- Java 2, Benjamín Aumaille, pág 21, Edición 2000, Editorial ENI.
- Programación en Java, C. Thomas Wu, págs. 40, 41, Edición 2008, Editorial McGraw-Hill.
- Introducción a la programación con Java, John S. Dean, Raymond H. Dean, pág. 53, Edición 2009, Editorial McGraw-Hill.
