Javadoc (Clase)

Hola que tal, aqui les dejo la importancia sobre el javadoc dentro de nuestro proyecto.

Bueno lo que es el javadoc en si, consiste en la documentacion de clases en java. Esto nos ayuda para guardar nuestro proceso en el trabajo, ademas de la facilidad del encuentro de errores en tu mismo programa. Al momento de compilar en javadoc, el codigo puede estar bien, sin embargo no sabes si te das a entender; lo que hace javadoc, es que te da a entender que es lo que haces, cuales son las librerias arriba y abajo, cuales son las clases padre e hijos.

Javadoc tambien nos da la facilidad de crear Aplicaciones para crear Doclets y taglets, que nos permite analizar la estructura de una aplicacion Java. Asi es como JDiff puede generar informes de lo que ha cambiado entre las versiones anteriores de una aplicacion.

La explicacion de tus clases se pueden poner dentro de los metodos o atributos, y tambien clases. Esta es la manera de poner los comentarios dentro del JavaDoc.

Para generar aplicaciones con Javadoc se deben de usar etiquetas de HTML o ciertas palabras escritas despues del caracter "@". Estas etiquetas se escriben al principio de cada clase, atributo o metodo dependiendo del objeto que se desee analizar, mediante un comentario que se inicia con "/**" y acabado con "*/".

Esta es una tabla de informacion que le puedes añadir a un Javadoc:

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

Me gustaria darles un ejemplo aleatorio, pero creo que es mejor darles un ejemplo con uno de mi projecto en la siguiente entrada.

Gracias.