martes, 29 de noviembre de 2011

Java: Como documentar los programas

La documentación se genera del archivo fuente, por lo que es necesario utilizar los comentarios especiales para JavaDoc:
/**
* Esto significa documentacion para JavaDoc
*/
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.

No hay comentarios:

Publicar un comentario