Java

avadoc 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. Lamayorí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 JDiffpuede generar informes de lo que ha cambiado entre dos versiones de una API.
Etiquetas Javadoc
Para generar APIs con Javadoc han de usarse etiquetas (tag's) de HTML o ciertas palabras reservadasprecedidas por el caracter "@".
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 acabadocon "*/".

A continuación se explican algunas de las palabras reservadas - puede verse una lista completa de las tags con su correpondiente uso en sun.com
Nota 1: En uso explica la semántica deltexto 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 | Indicaque 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, esrequerido 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_clasedescripción | 1.2 |
@version | Versión del método o clase. | versión | 1.0 |
Ejemplo
Un ejemplo de un Javadoc de un método0.
/**
* Inserta un título en la...