Javadoc
# Javadoc

Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente.

Javadoc también proporciona una API para crear doclets y taglets, que le permite analizar la estructura de una aplicación Java. Así es como JDiff puede generar informes de lo que ha cambiado entre dos versiones de una API.

## Etiquetas Javadoc

Para generar API con Javadoc han de usarse etiquetas (tags) de HTML o ciertas palabras reservadas precedidas por el carácter "@". Estas etiquetas se escriben al principio de cada clase, miembro o método, dependiendo de qué objeto se desee describir, mediante un comentario iniciado con "/**" y acabado con "*/".

A continuación se explican algunas de las palabras reservadas - puede verse una lista completa de las tags con su correspondiente uso en oracle.com.

Nota 1: En uso explica la semántica del texto tras el tag. Nota 2: Versión indica desde qué versión de Javadoc es válida.

    TagDescripciónUsoVersión @authorNombre del desarrollador.nombre_autor1.0 @versionVersión del método o clase.versión1.0 @paramDefinición de un parámetro de un método, es requerido para todos los parámetros del método.nombre_parametro descripción1.0 @returnInforma de lo que devuelve el método, no se puede usar en constructores o métodos "void".descripción1.0 @throwsExcepción lanzada por el método, posee un sinónimo de nombre @exceptionnombre_clase descripción1.2 @seeAsocia con otro método o clase.referencia (#método; clase#método; paquete.clase; paquete.clase#método).1.0 @sinceEspecifica la versión del productoindicativo numerico1.2 @serialDescribe el significado del campo y sus valores aceptables. Otras formas válidas son @serialField y @serialDatacampo_descripcion1.2 @deprecatedIndica que el método o clase es antigua y que no se recomienda su uso porque posiblemente desaparecerá en versiones posteriores.descripción1.0

## Ejemplo

Un ejemplo de un Javadoc de un método.

