Los comentarios en el código en Java son útiles porque nos permiten agregar notas para explicar código y hacerlo más legible. Comentando también es posible controlar la ejecución de algunos segmentos de código y probar nuevas líneas que nos permitan resolver un problema si borrar lo que se tenía anteriormente.
Existen dos tipos de comentarios:
- Una sola línea
- Comentarios multi-línea.
Comentarios de una sola línea
Los comentarios de una sola línea comienzan con dos barras diagonales //.
El texto que esté entre dobles diagonales y un salto de línea será ignorado por el compilador.
A continuación un ejemplo:
//Esto es un comentario de una sola línea
System.out.println("Este código si se compila y se ejecuta");
Otra forma válida de un comentario es después de una sentencia de código y antes del salto de línea:
System.out.println("Hola"); //Este comentario es válido también
Comentarios multi-línea
Los comentarios de varias líneas comienzan con una diagonal seguida de un asterisco y cierran con un asterisco seguido de una diagonal. Cualquier texto entre /* y */ será ignorado por el compilador de Java.
A continuación un ejemplo:
public class Ejemplo {
public static void main(String args[]) {
/*
Este texto es un comentario multi-línea,
puede extenderse en una o más líneas.
*/
System.out.println("Hola Mundo");
}
}
Es posible comentar código tan sólo para probar algo nuevo:
public class Ejemplo {
public static void main(String args[]) {
/*
System.out.println("Hello World");
*/
System.out.println("Hola Mundo");
}
}
También es común agregar comentarios en el código de Java al inicio de cada método para describir un poco su funcionamiento y hacerlo más legible.
Más información en inglés: https://geekole.com/code-comments-in-java/