1 M.C. Juan Carlos Olivares RojasJavaDoc M.C. Juan Carlos Olivares Rojas

2 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.

3 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

4 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#método(); paquete.clase#método(). @throws clase descripcion @version versión

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

6 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. * unascribed 1.16, 02/02/00 java.lang.Integer#toString()

7 Ejemplo JDK1.0 */ public class NumberFormatException extends IllegalArgumentException { /** * Constructs a NumberFormatException with no detail message. public NumberFormatException () { super(); }

8 Ejemplo /** * Constructs a NumberFormatException with the * specified detail message. s the detail message. */ public NumberFormatException (String s) { super (s); } }

9 ¿Preguntas, dudas y comentarios?