Java Doc M C Juan Carlos Olivares Rojas

Java. Doc M. C. Juan Carlos Olivares Rojas

Introducción • Es el estándar para crear documentación para los proyectos en Java. • Es una herramienta estándar del JDK de Sun Microsystem. Crea documentación en HTML y casi cualquier IDE lo hace. • Se deben utilizar los comentarios especiales /** …. . */ con algunas palabras clave para determinar la documentación.

Elementos • Las palabras clave inician con una arroba. • Se puede incrustar cualquier etiqueta de HTML para hacer más visible la documentación. • @author nombre_desarrollador • @deprecated descripción //indica un método que no se utiliza su uso

Elementos • @param nombre descripción • @return descripción //no se debe utilizar con métodos void. • @see referencia //asocia con otro elemento el cual puede ser: #método(); clase#método(); paquete. clase#método(). • @throws clase descripcion • @version versión

Generación de la Documentación • La documentación se crea de la siguiente forma: javadoc archivo. java • En Net. Beans se puede encontrar la opción en el menú Build en la opción Generate Java. Doc for … • Se recomienda realizar tanto el código como las clases en inglés.

Ejemplo /** * Thrown to indicate that the application has attempted to convert * a string to one of the numeric types, but that the string does not * have the appropriate format. * * @author unascribed * @version 1. 16, 02/02/00 * @see java. lang. Integer#to. String()

Ejemplo * @since JDK 1. 0 */ public class Number. Format. Exception extends Illegal. Argument. Exception { /** * Constructs a <code> Number. Format. Exception </code> with no detail message. */ public Number. Format. Exception () { super(); }

Ejemplo /** * Constructs a <code> Number. Format. Exception </code> with the * specified detail message. * @param s the detail message. */ public Number. Format. Exception (String s) { super (s); } }

¿Preguntas, dudas y comentarios?