You are on page 1of 8

Documentacin

en Java:
Javadoc
Programacin 2 Curso 2010/2011

Juan Manuel Gimeno
Jos Luis Gonzlez

La documentacin de Java
Tanto la biblioteca estndar de Java como la
de la ACM sn muy extensas
MulGtud de clases
MulGtud de mtodos

Es imposible conocerlos todos con detalle


suciente como para uGlizarlos correctamente
Por ello es muy importante disponer de una
muy buena documentacin.

La documentacin de Java
Es por ello que los diseadores de Java,
denieron un mtodo sencillo para generar la
documentacin de las clases y mtodos:
La documentacin se inserta en el mismo chero que
el cdigo (en forma de comentarios)
De esta manera es ms fcil que evolucione con l

La herramienta javadoc extrae esos comentarios


especiales y genera pginas html para ser vistas desde
el navegador
De esta manera facilitamos poder navegar de una clase a
otra.

Accediendo a la documentacin
Como cuando
conguramos las
bibliotecas de la ACM
aadimos el javadoc,
podemos acceder a l a
parGr del apartado
bibliotecas de nuestro
proyecto
Tambin podemos
acceder a las de la
biblioteca de Java

Aadiendo comentarios javadoc


Aadir documentacin 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
parmetros y el resultado.
Hay muchas marcas interesantes como por
ejemplo @author, @version, @since, @throws,
etc.

Cmo generarlo
Generar la
documentacin en
Netbeans es tan fcil
como, desde el
proyecto, marcar en el
men contextual la
opcin Generar
javadoc
Una vez generada, nos
abrir el navegador
para acceder a ella.

Accediendo al javadoc
Los cheros generados
los encontraris en el
subdirectorio dist/
javadoc dentro del
proyecto.

You might also like