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 APIs 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 correpondiente 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.

Tag Descripción Uso Versión
@author Nombre del desarrollador. nombre_autor 1.0
@deprecated Indica que el método o clase es antigua y que no se recomienda su uso porque posiblemente desaparecerá en versiones posteriores. descripción 1.0
@param Definición de un parámetro de un método, es requerido para todos los parámetros del método. nombre_parametro descripción 1.0
@return Informa de lo que devuelve el método, no se puede usar en constructores o métodos "void". descripción 1.0
@see Asocia con otro método o clase. referencia (#método(); clase#método(); paquete.clase; paquete.clase#método()). 1.0
@throws Excepción lanzada por el método nombre_clase descripción 1.2
@version Versión del método o clase. versión 1.0
Other Languages
čeština: Javadoc
Deutsch: Javadoc
English: Javadoc
français: Javadoc
italiano: Javadoc
日本語: Javadoc
Nederlands: Javadoc
norsk nynorsk: Javadoc
norsk bokmål: Javadoc
polski: Javadoc
português: Javadoc
русский: Javadoc
svenska: Javadoc
українська: Javadoc