un aporte a java: documentacion de nuestro codigo con javadoc

viernes, 7 de noviembre de 2008

documentacion de nuestro codigo con javadoc

la idea de javadoc es proporcionar de forma facil una forma de
documentar nuestro codigo , lo simpatico esque nos crea nuestra
documentacion de la misma forma de la api de java

Como siempre trabajaremos con nuestro querido netbeans

1.- tenemos que bajar el plugins

despues de instarlo podemos ver la configuracion en tools->options

2.- es super simple utilizarlo , antes de los metodos
escribimos /** y enter y solo nos genera un trozo de comentario , el cual
llenamos con la descripcion que deseamos.

Palabra reservada	Versión	Descripción
@author	1.0	El autor del método, clase.
@deprecated	1.0	El método ha sido reemplazado por otro.
@exception	1.0	La excepción que puede generar.
@param	1.0	Después viene el parámetro, esto se hace para
		documentar todos los parámetros que requiere el método.
@return	1.0	El valor que regresa
@see	1.0	Una referencia a otra clase o método de utilidad
@since	1.1	La versión desde que se incluye.
@throws	1.2	Es un sinónimo para @exception.
@version	1.0	La versión del método, clase.

tenemos tambien el un visor para ir creado los comentarios y este se
encuentra en Source->analyze javadoc

3.- y por ultimo para generar uno javadoc tenemos que ir sobre nuestro proyecto
y con las opciones del boto derecho de mouse seleccionamos generate javadoc.

Asi nos muestra la documentacion