Comentarios de inline
// Este es un comentario de línea simple
int x = 5; // Este es otro comentario de línea simple
Comentarios multilinea
/* Este es un comentario de bloque
que abarca varias líneas */
int y = 10;
Comentarios JavaDoc
Notar que:
-
Empiezan por /** y terminan por */.
-
Es necesario que estén inmediatamente encima del elemento que queremos documentar.
-
Se suelen usar para documentar métodos y clases.
/**
* Este método suma dos números enteros
* @param a El primer número a sumar
* @param b El segundo número a sumar
* @return La suma de a y b
*/
public int sumar(int a, int b) {
return a + b;
}
Aunque JavaDoc es una herramienta para terminal, que viene con OpenJDK tu IDE te proporcionará sugerencias al escribir un @ dentro de dicha documentación.
Algunas de las etiquetas específicas que te puede sugerir son:
- @param: para documentar los parámetros de un método.
- @return: para documentar el valor de retorno de un método.
- @throws: para documentar las excepciones que pueden ser lanzadas por un método.
- @author: para documentar el autor del código.
- @version: para documentar la versión del código.
Así se vería al ejecutarlo en tu IDE: