@see nombre_de_clase

Añade un link a la clase en la zona "See Also". Por ejemplo:

  @see java.lang.String
  @see String
  @see String#equals
  @see java.lang.Object#waint(int)
  @see Character#MAX_RADIX
  @see <A HREE="spec.html">Especif. Java</A>

El carácter # separa el nombre de una clase del nombre de uno de sus campos, métodos o constructores. Un comentario de documentación puede incluir más de una marca @see.

@version texto-version

Añade una entrada "Version". El texto no tiene que tener formato especial. Un comentario de documentación puede incluir más de una marca @version.

@author texto-autor

Añade una entrada "Author". El texto no tiene que tener formato especial. Un comentario de documentación puede incluir más de una marca @author.

@since texto

Este texto no tiene una estructura especial. Se utiliza para indicar desde qué fecha o desde qué versión se ha introducido el cambio o característica que indica el texto.

@deprecated texto

Añade un comentario indicando que no debería utilizarse la función o método, porque puede dejar de ser soportada por el API. La convención que se sigue es indicar en el texto la función o método por quien se ha sustituido. Por ejemplo:

@deprecated Replaced by setBounds(int,int,int,int)

Si el miembro está ya obsoleto y eliminado, el texto que sigue al tag @deprecated debe ser "No replacement".

Ejemplo de comentario de una clase:

    /**
     * Clase que presenta una ventana en la pantalla.
     * Por ejemplo:
     * <PRE>
     *    Window ventana = new Window( padre );
     *    Ventana.show();
     * </PRE>
     *
     * @see        awt.BaseWindow
     * @see        awt.Button
     * @version    1.3 15 Ene 97
     * @author     Agustin Froufe
     */
    class Window extends BaseWindow {
        . . .
    }

@param parametro descripcion

Añade un parámetro a la sección "Parameters". La descripción puede continuar en la línea siguiente.

@return descripcion

Añade una sección "Return", que debe contener la descripción del valor de retorno.

@exception nombre_de_la_clase descripcion

Añade una entrada "Throws", que contiene el nombre de la excepción que puede ser lanzada por el método. La excepción estará enlazada con su clase en la documentación.

@see nombre_de_clase

Añade un link a la clase en la zona "See Also".

@since texto

Indica desde qué fecha o desde qué versión se ha introducido el cambio o característica que indica el texto.

@deprecated texto

Indica que no debería utilizarse la función o método, porque puede dejar de ser soportada por el API.

Ejemplo de comentario de un método:

    /**
     * Devuelve el carácter de la posición indicada entre
     * <TT>0</TT> y <TT>length()-1</TT>
     * @param indice La posición del carácter a obtener
     * @return       El carácter situado en la posición
     * @exception    StringIndexOutOfRangeException
     *               Se prodcue cuando el indice no está en
     *               el rango <TT>0</TT> a <TT>length()-1</TT>
     */
    public char charAt( int indice ) {
        . . .
    }

-doclet fichero

Especifica el fichero que contiene la configuración del formato de salida que se desea generar. Si no se especifica, se generará una salida con formato html estándar.

-sourcepath path

Especifica el camino de búsqueda de los ficheros fuente .java. No afecta a la carga de los ficheros de clases .class.

-classpath path

No es conveniente utilizar esta opción, porque no es necesaria habitualmente; es mejor utilizar -sourcepath para indicar donde se encuentran los ficheros .java a documentar. Especifica el camino que javadoc usa para encontrar los ficheros .java. También indica los directorios desde los que javadoc carga sus propios ficheros .class. Sobreescribe el establecido por defecto o la variable de entorno CLASSPATH si ésta ha sido establecida anteriormente. Los directorios en la variable CLASSPATH son separados con punto y coma (;). El formato general para el path es:

.;<tu_camino>

Por ejemplo:

.;C:\users\afq\javasrc

-encoding nombre

Especifica el tipo de codificación del fichero fuente, como EUCJIS\SJIS. Si no se especifica, se usa en conversor de defecto de la plataforma.

-Jflag

Pasa flag directamente al sistema operativo. Por ejemplo, si es necesario que limitemos la memoria utilizada por el sistema a 32 megabytes para generar la documentación, podríamos utilizar este flag de la forma siguiente:

javadoc -J-Xmx32m -J-Xms32m &ltclasees> …

-package

Imprime paquetes y clases y miembros públicos y protected.

-private

Muestra todo tipo de clases y sus miembros.

-protected

Muestra solamente las clases públicas y protected y sus miembros. Es la opción de defecto.

-public

Muestra solamente clases y miembros públicos.

-verbose

Sin esta opción aparecen mensajes de carga de ficheros, generación de documentación (un mensaje por fichero) y ordenación. Con esta opción se muestran mensajes adicionales especificando el número de milisegundos empleado en generar la documentación de cada fichero Java.

-author

Incluye las marcas @author, que por defecto son omitidos.

-d directorio

Especifica un directorio en donde javadoc almacena los archivos HTML que genera. (La "d" significa "destino"). El directorio puede ser absoluto o relativo al directorio de trabajo. Por defecto se utiliza el directorio actual.

-linkall

Crea links a la documentación del API para todas las clases que referencien algún documento del API que se está generando. Por ejemplo, si javadoc está corriendo sin esta opción sobre el fichero Graphics.java del paquete java.awt, la línea de comandos sería:

javadoc C:\java\awt\Graphics.java

La signature para el método Graphics.toString() en el html generado por javadoc tendría una apariencia como:

<pre>
 public String toString()
</pre>

No se generan enlaces a la documentación del API del JDK para la clase String no está incluida como entrada en el comando de llamada a javadoc. Sin embargo, si ahora se emplea la opción -linkall:

javadoc -linkall C:\java\awt\Graphics.java

sí se genera un enlace a la documentación del API para la clase String:

<pre>
 public<a href="java.lang.String.html#_top_">String</a>  toString()
</pre>

Del mismo modo se incluirán enlaces a todas las referencias a clases no especificadas en la línea de comandos. Hay que tener en cuenta que los enlaces se realizan suponiendo que la documentación del API se encuentra en el mismo directorio que la documentación que está siendo generada por javadoc.

-nodeprecated

Excluye los párrafos que contengan el tag @deprecated.

-noindex

Omite el índice del paquete, que por defecto es generado.

-notree

Omite la jerarquía de clases/interface, que por defecto es generada.

-breakindex

Divide el índice en 26 ficheros, uno por cada letra.

-footer texto

Coloca el texto que se indique en cada una de las páginas que se generen, inmediatamente antes del tag </body>. Si en texto contiene espacios, debe ir encerrado entre comillas simples o dobles.

-version

Incluye las marcas @version, que por defecto son omitidas.