Inserción de comentarios en el código fuente

En el código fuente de un programa Java es posible escribir texto de forma libre, es decir, sin tener que seguir las normas del lenguaje Java, con el fin de indicar comentarios sobre las sentencias del programa. El texto escrito como comentario no es tenido en cuenta por el compilador.

Es recomendable escribir este tipo de comentarios ya que facilita la compresión del programa cuando es leído por otra persona o por el mismo creador, especialmente cuando ha pasado algún tiempo desde que fue escrito el código.

Para escribir un comentario, éste puede ir precedido por dos barras //, o bien, encerrado entre los caracteres /* y */. Si se utilizan las dos barras, el comentario sólo se puede escribir en una línea, a partir de esos caracteres. En caso de que el comentario vaya a ocupar más de una línea se debe utilizar el segundo método: /* comentario */.

Ejemplo:

// Esta línea es un comentario

System.out.println("Saludo"); // Comentario detrás

// Esta es la forma de comentar más de una línea utilizando
// las dos barras. Se incluyen dos barras al comienzo
// de cada línea

/* Esta segunda forma es mucho más cómoda para comentar
un número elevado de líneas ya que sólo requiere modificar
el comienzo y el final. */

Java incluye una utilidad llamada javadoc, que permite generar de forma automática alguna documentación de las aplicaciones. Para darle determinados datos a esa utilidad, se utiliza otro tipo de comentarios que comienzan con /** y terminan con */. Por ejemplo:

    /**
     * @param args the command line arguments
     */