Giovanni Galileo Mata Aguilar

Presentación del tema: "Giovanni Galileo Mata Aguilar"— Transcripción de la presentación:

1 Giovanni Galileo Mata Aguilar
Javadoc Giovanni Galileo Mata Aguilar

2 Javadoc Javadoc es una utilidad de Sun Microsystems 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.

3 Para generar APIs con Javadoc han de usarse etiquetas (tag's) de HTML o ciertas palabras reservadas precedidas 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 acabado con "*/".

4 javadoc -version -author nombre_del_paquete
Creación Del JavaDoc Tan simple como poner en la línea de comandos: javadoc -version -author nombre_del_paquete

5 Palabras reservadas 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 @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 @return Informa de lo que devuelve el método, no se puede usar en constructores o métodos "void". @see Asocia con otro método o clase. referencia (#método(); clase#método(); paquete.clase; paquete.clase#método()). @throws Excepción lanzada por el método nombre_clase descripción 1.2 @version Versión del método o clase. versión