Javadoc

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 mayoria de los IDEs los generan automaticamente.

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, me diente un comentario iniciado con "/**" y acabado con "*/". A continuación explicamos algunas de las palabras reservadas; recordar que tras la etiqueta separado de un espacio se pone "Uso":

Tag	Descripcion	! Uso
@author	Nombre del desarollador.	El nombre
@deprecated	Indica que la funcion o clase es antigua y que no se recomienda su uso porque posiblemente desaparecera en versiones posteriores.	Una explicaion o nada.
@param	Definicion de un parametro de una funcion, es requerido para todos los parametros de la funcion.	El nombre del parametro y una descripcion
@return	Informa de lo que devuelve la funcion, no se puede usar en construcctores o metodos "void".	Una descripcion
@see	Asocia con otro metodo o clase.	El paquete de la clase.
@throws	Excepcion lanzada por el metodo	Descripcion
@version	Version del metodo o clase.	El numero de version

Ejemplo

Un ejemplo de un Javadoc de una funcion.

/**
 * Inserta un titulo en la clase descripcon.

 * @autor Victor. Ant. Torre
 * @param title El nuevo titulo de la descripcion.
 * @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;

}