Javadoc
De Wikipedia, la enciclopedia libre
Javadoc Es una utilidad de Sun Microsystems para generar APIs de documentos en HTML de un documento en Java.
Javadoc es un standard industrial para documentar clases de Java. La mayoría de los IDEs los generan automáticamente.
[editar] Javadoc tags
Para generarlos han de usarse tag's de HTML o ciertas palabras reservadas precedidas de "@".
Este documento se escribe al principo de cada clase y de las funciones, mediante un comentario iniciado con "/**" y acabado con "*/".
A continuación explicamos algunas de las palabras reservadas:
Nota 1: En uso explica lo que se pone tras el tag.
Nota 2: Versión es desde que versión de Javadoc es valida.
-
Tag Descripción ! Uso Versión @author Nombre del desarollador. nombre_autor 1.0 @deprecated Indica que la función 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 una función, es requerido para todos los parámetros de la función. nombre_parametro descripción 1.0 @return Informa de lo que devuelve la función, no se puede usar en construcctores o métodos "void". descripción 1.0 @see Asocia con otro método o clase. referencia (#función(); clase#función(); paquete#clase; paquete.clase#función()). 1.0 @throws Excepción lanzada por el método nobre_clase descripción 1.2 @versión Versión del método o clase. versión 1.0
[editar] Ejemplo
Un ejemplo de un Javadoc de una función.
/**
* Inserta un título en la clase descripcon.<br/>
* Al el título oblibatirio si es mulo o vacío lanzará
* una excepción.
* @autor Victor. Ant. Torre
* @param title El nuevo título de la descripción.
* @throws Exception Si title es null o "", " ", ...
*/
public void setTitle(String title) throws Exception {
if(title==null || "".equals(title.trim()))
throw new Exception(Item.TITLE_NULL);
else
this.title = title;
}
