Java doc

Documentación de programas Java
• En el diseño del lenguaje se ha tenido en cuenta la documentación de los programas y el mantenimiento de dicha documentación • La documentación y el código seincluyen dentro del mismo fichero • Tipo de comentario específico para documentar
❏

Documentación de programas: javadoc

/** Comentario de documentacion */

• Inclusión de una herramienta para laextracción de la documentación --> javadoc • Generación de documentación en HTML • Este principio se ha aplicado al propio lenguaje de modo que la documentación de la API se ha generado con javadocJava javadoc bfm 1 Java javadoc bfm 2

Uso de javadoc
• Dos modos de uso • Inclusión de texto con formato HTML en los comentarios de documentación • Utilización de la etiquetas de documentación
❏Ejemplo
• Elementos a comentar
Clases e Interfaces Variables ❏ Métodos
❏ ❏

Estas etiquetas empiezan por @ y se colocan al principio de la línea aunque pueden tener un * inicial que se ignoraComentario de una clase y todos sus elementos públicos

• Los comentarios deben aparecer inmediatamente antes de los elementos a comentar • La primera frase de cada comentario de documentación debeser un resumen que contenga una descripción completa y concisa de la entidad declarada. • Se deben comentar por lo menos los elementos públicos y protegidos
Java javadoc bfm 3

/** Comentario dela clase docTest * este comentario puede tener varias líneas * en cuyo caso se suelen incluir estos asteriscos iniciales*/ public class PruebaDeDocumentacion { /** Comentario de la variable numero */public int numero; /** Comentario del metodo prueba */ public void prueba() {} }
Java javadoc bfm 4

Ejemplo del uso de HTML
• Dentro de los comentarios de documentación se pueden incluir códigosde formato HTML • No usar cabeceras (p.e. ) o separadores (p.e. )

Etiquetas de documentación
• Generales • @see referencia
❏ ❏

Permite referirse a la documentación de otras clases Genera una...