Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Javadoc Con NetBeans PDF
Javadoc Con NetBeans PDF
Un comentario de documentacin empieza con los caracteres /** y termina con los
caracteres */. Cada comentario consiste de una descripcin seguida de una o ms
etiquetas. Se pueden usar etiquetas de formateo HTML en los comentarios de
documentacin.
Sugerencias:
/**
* Este metodo regresa la clave del genero
* @return La clave del genero
*/
Figura 1
Por ejemplo, el siguiente listado muestra una clase con comentarios de documentacin:
Medio.java
/*
* Medio.java
*
* Creada el 8 de septiembre de 2006, 01:14 PM
*/
package objetosNegocio;
import objetosServicio.Fecha;
/**
* Esta clase contiene los atributos y mtodos comunes a las clases
* Cancion y Pelicula del programa AmanteMusica
*
* @author mdomitsu
*/
public class Medio {
protected String clave;
protected String titulo;
protected Genero genero;
protected int duracion;
protected Fecha fecha;
/**
* Constructor predeterminado
*/
public Medio() {
}
/**
* Constructor que inicializa los atributos de la clase
* @param clave Clave de la cancin o pelcula
* @param titulo Ttulo de la cancin o pelcula
* @param genero Gnero de la cancin o pelcula
* @param duracion Duracin de la cancin o pelcula
* @param fecha Fecha de liberacin de la cancin o pelcula
*/
public Medio(String clave, String titulo, Genero genero, int duracion,
Fecha fecha) {
this.clave = clave;
this.titulo = titulo;
this.genero = genero;
this.duracion = duracion;
this.fecha = fecha;
}
/**
* Regresa la clave de la cancin o pelcula
* @return Clave de la cancin o pelcula
*/
public String getClave() {
return clave;
}
/**
* Establece la clave de la cancin o pelcula
* @param clave Clave de la cancin o pelcula
*/
public void setClave(String clave) {
this.clave = clave;
}
/**
* Regresa el ttulo de la cancin o pelcula
/**
* Establece el ttulo de la cancin o pelcula
* @param titulo Titulo de la cancin o pelcula
*/
public void setTitulo(String titulo) {
this.titulo = titulo;
}
/**
* Regresa el gnero de la cancin o pelcula
* @return Gnero de la cancin o pelcula
*/
public Genero getGenero() {
return genero;
}
/**
* Establece el gnero de la cancin o pelcula
* @param genero Gnero de la cancin o pelcula
*/
public void setGenero(Genero genero) {
this.genero = genero;
}
/**
* Regresa la duracin de la cancin o pelcula
* @return Duracin de la cancin o pelcula
*/
public int getDuracion() {
return duracion;
}
/**
* Establece la duracin de la cancin o pelcula
* @param duracion Duracin de la cancin o pelcula
*/
public void setDuracion(int duracion) {
this.duracion = duracion;
}
/**
* Regresa la fecha de liberacin de la cancin o pelcula
* @return Fecha de liberacin de la cancin o pelcula
*/
public Fecha getFecha() {
return fecha;
}
/**
* Establece la fecha de liberacin de la cancin o pelcula
* @param fecha Fecha de liberacin de la cancin o pelcula
*/
public void setFecha(Fecha fecha) {
this.fecha = fecha;
}
/**
* Regresa una cadena con los valores de los atributos de una instancia de
* la clase
* @return Cadena con los valores de los atributos
*/
public String toString() {
return clave + ", " + titulo + ", " + genero.getNombre() + ", " +
duracion + ", " + fecha;
}
}
Etiquetas Javadoc
En la tabla 2.1 se muestran las etiquetas de documentacin.
Tabla 2.1
Etiqueta Descripcin Tipo de Etiqueta
@author nombre Agrega una entrada de autor con el nombre Resumen, paquete,
especificado en el documento. Normalmente clase, interfaz
no se incluye en la documentacin.
@versin versin_no Agrega un subencabezado con el nmero de Resumen, paquete,
versin especificado. Normalmente no se clase, interfaz
incluye en la documentacin.
@param nomPar descripcin Agrega un parmetro al subencabezado Constructor,
Parmetros. mtodo
@return descripcin Agrega un subencabezado Return con el texto Constructor,
de la descripcin. mtodo
@deprecated texto Agrega un comentario indicando que la API Paquete, clase,
ha sido descontinuada. Normalmente no se interfaz, atributo,
incluye en la documentacin. constructor,
mtodo
@exception nomClase descripcin Agrega un subencabezado Throws al Constructor,
documento con el nombre de la clase de la mtodo
excepcin que puede lanzar.
@throws nomClase descripcin Sinnimo de @exception Constructor,
mtodo
{@value} Se utiliza con atributos estticos. Despliega el Atributos
valor de la constante en la pgina de atributos
constantes.
Figura 2
4. Al lado derecho del nombre del parmetro de cada etiqueta @param describa el
propsito del parmetro.
Figura 3
Generacin de la Documentacin
Javadoc
NetBeans puede producir un conjunto de pginas HTML Javadoc que describe las
clases, constructores, mtodos y atributos, a partir de la estructura del cdigo y los
comentarios de documentacin incluido en el cdigo.
Figura 4
Otra forma de generar la documentacin Javadoc, es hacer clic con el botn derecho
en el nombre del proyecto en el rbol de proyectos y seleccione la opcin Generate del
men emergente, figura 5.
Figura 5
En ambos casos, NetBeans genera las pginas HTM Javadoc, mostrando el avance en
la ventana de salida, figura 6.
Figura 6
Figura 7
Haciendo clic en las ligas podemos ver la documentacin de las diferentes clases del
proyecto. Por ejemplo, en la figura 8 se muestra la documentacin de la clase Genero.
Figura 8
Configuracin de Javadoc
Podemos configurar como NetBeans generar la documentacin Javadoc para el
proyecto
Figura 9
Figura 10
Figura 11