UNIVERSIDAD TECNICA PARTICULAR DE LOJA

COMPUTACIÓN

TRABAJO REALIZADO POR:

Adrián Alessandro Rivera Cueva, Carlos Daniel Escudero Mena.

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

Tag	Descripción	Uso	Versión
@author	Nombre del desarrollador	nombre_autor	1.0
@version	Versión del método o clase	versió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
@throws	Excepción lanzada por el método, posee un sinónimo de nombre @exception	nombre_clase descripción	1.2
@see	Asocia con otro método o clase	referencia (#método(); clase#método(); paquete.clase; paquete.clase#método())	1.0
@since	Especifica la versión del producto	indicativo numerico	1.2
@serial	Describe el significado del campo y sus valores aceptables. Otras formas válidas son @serialField y @serialData	campo_descripcion	1.2
@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

EJEMPLO:

DOCUMENTAR PROYECTOS JAVA CON JAVADOC

Documentar un proyecto es algo fundamental de cara a su futuro mantenimiento. Cuando programamos una clase, debemos generar documentación lo suficientemente detallada sobre ella como para que otros programadores sean capaces de usarla sólo con su interfaz. No debe existir necesidad de leer o estudiar su implementación, lo mismo que nosotros para usar una clase del API Java no leemos ni estudiamos su código fuente.

VEAMOS EN PRIMER LUGAR QUE SE DEBE INCLUIR AL DOCUMENTAR UNA CLASE:

• Nombre de la clase, descripción general, número de versión, nombre de autores.
• Documentación de cada constructor o método (especialmente los públicos) incluyendo: nombre del constructor o método, tipo de retorno, nombres y tipos de parámetros si los hay, descripción general, descripción de parámetros (si los hay), descripción del valor que devuelve.

Las variables de instancia o de clase no se suelen documentar a nivel de javadoc.

Para generar la documentación de un proyecto automáticamente hemos de seguir unas normas a la hora de realizar los comentarios dentro del mismo. Si las hemos seguido, en BlueJ disponemos de la opción del menú Tools --> Project Documentation, que nos abre la documentación del proyecto en un navegador web.

En NetBeans para generar la documentación se debe hacer clic derecho sobre el proyecto y hacer clic en Generate JavaDoc, que nos abre la documentación del proyecto en un navegador web.

En IntelliJ debes hacer clic en la pestaña de Tools y hacer clic en Generate JavaDoc, que nos abre la documentación del proyecto en un navegador web.

En Sun ONE Studio debes hacer clic en la pestaña de Tools y hacer clic en Generate JavaDoc, que nos abre la documentación del proyecto en un navegador web.

En Eclipse para generar la documentación se debe hacer clic en Project y hacer clic en Generate JavaDoc, que nos abre la documentación del proyecto en un navegador web.

En Android Studio debes hacer clic en la pestaña de Tools y hacer clic en Generate JavaDoc, que nos abre la documentación del proyecto en un navegador web.