Iagovar

Tres tipos de comentarios en java: Inline, multiline y JavaDoc

En Java, además de los comentarios de una línea y multilinea, existen los JavaDocs.

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:

  1. Empiezan por /** y terminan por */.

  2. Es necesario que estén inmediatamente encima del elemento que queremos documentar.

  3. 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:

Así se vería al ejecutarlo en tu IDE:

Más info