1 / 9

JavaDoc

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

zia
Download Presentation

JavaDoc

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript


  1. JavaDoc 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ón • La 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. * * @author unascribed * @version 1.16, 02/02/00 * @see java.lang.Integer#toString()

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

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

  9. ¿Preguntas, dudas y comentarios?

More Related