¿Qué es Javadoc y cómo escribes documentaciones con él?

Answer 1

Es un lenguaje de marcado, incrustado directamente en el archivo Java a través de un tipo especial de comentario, /** */ . Hay algunas etiquetas para marcar los elementos, como @param , @return , @throws y algunas etiquetas para el formato de texto, como {@link} y {@code} . También puede usar algunas etiquetas HTML.

La forma idiomática de usarlo es dejar que un analizador analice el proyecto que está documentando. Detecta todos los JavaDocs y crea una documentación HTML a partir de eso. La referencia de biblioteca estándar se creó exactamente de esa manera. Sin embargo, todos los IDE también los conocen y pueden mostrar documentación para un determinado elemento si JavaDoc está presente.

/ **
* Calcula un factorial usando {@link IntStream} sin una buena razón.
* @param n el argumento del factorial
* @ devuelve el producto de todos los enteros entre 1 yn, o 1, si n = 0.
* @throws IllegalArgumentException si el parámetro dado es negativo.
* /

public static int factorial (int n) {
si (n <0) {
lanzar una nueva IllegalArgumentException (“Factorial no está definido para enteros negativos”);
}
return IntStream.rangeClosed (1, n)
.reduce (1, (a, b) -> a * b);
}