Documentación en Java – Javadoc

Tanto la biblioteca estándar de Java como la de la ACM son muy extensas 
–  Multitud de clases 
–  Multitud de métodos 
Es imposible conocerlos todos con detalle suficiente como para utilizarlos correctamente 
Por ello es muy importante disponer de una muy buena documentación. 
Es por ello que los diseñadores de Java, definieron un método sencillo para generar la documentación de las clases y métodos: 
–  La documentación se inserta en el mismo fichero que el código (en forma de comentarios) 
    •  De esta manera es más fácil que evolucione con él 
–  La herramienta javadoc extrae esos comentarios especiales y genera páginas html para ser vistas desde 
el navegador 
    •  De esta manera facilitamos poder navegar de una clase a otra. 
Añadiendo comentarios javadoc 
•  Añadir documentación es tan simple como poner un comentario que empiece por /** y acabe con */ 
•  Para poder estructurar mejor los comentarios dentro del comentario usaremos las marcas @param y @return para describir con detalle los parámetros y el resultado. 
•  Hay muchas marcas interesantes como por ejemplo @author, @version, @since, @throws, etc. 
Cómo generarlo 
•  Generar la documentación en Netbeans es tan fácil como, desde el proyecto, marcar en el menú contextual la opción “Generar javadoc” 
•  Una vez generada, nos abrirá el navegador para acceder a ella. 
Accediendo al javadoc 
•  Los ficheros generados los encontraréis en el subdirectorio dist/javadoc dentro del proyecto. 

  • Share:

Deja un comentario

Your email address will not be published.

Enviar un mensaje

Este sitio web utiliza cookies para que usted tenga la mejor experiencia de usuario. Si continúa navegando está dando su consentimiento para la aceptación de las mencionadas cookies y la aceptación de nuestra política de cookies, pinche el enlace para mayor información.

ACEPTAR
Aviso de cookies