Javadoc Manual

Manual de Uso de Javadoc e instalacion de JAutodoc en Eclipse

autor : Gonzalo Segura

El presente documento tiene como objetivo el facilitar la documentacion java, mediante la utilizacion
delestandar Javadoc.
Para la realizacion de este manual se utiliza las herramientas.
• Eclipse Helios.
• Java jdk1.6.0_30
• Java jdk1.7.0_02
• JAutodoc 1.10.0
JavaDoc es un estandar para la documentar elcodigo java y utiliza Tag que se agregan al codigo java,
los mas utilizados son los que se describen a continuacion.

Tag

Descripción

@autor

Nombre del desarrollador

@deprecated

Indica que el métodoo clase es antigua.

@param

Definicion de un parametro de un metodo

@return

Informa lo devuelve el metodo

@see

Asocia con otro metodo o clase

@throws

Excepcion lanzada por el metodo

@versionVersion del metodo o clase

En la siguiente imagen puede observarse los Tag agregados al codigo java.

Ilustración 1: Tag en Clase Java

Estos Tag generan la documentacion java, un documento HTMLnavegable que contiene la
documentacion de java.

Ilustración 2: Documentacion java en HTML
Para generar el JavaDoc en eclipse debe seleccionarse en el menu Proyect->Generate Javadoc como lo
muestra lasiguiente imagen.

Ilustración 3: Generar JavaDoc en eclipse, paso 1

Para generar el JavaDoc se debe ejecutar el javadoc.exe que se encuentra en el jdk1.6.0_30, en la ruta
C:\ProgramFiles\Java\jdk1.6.0_30\bin\javadoc y la ruta de destino.

Ilustración 4: Generar JavaDoc en Eclipse, paso 2

Instalacion de JAutodoc.
JAutodoc es un plugin de eclipse que permite añadir, de forma automática headersy javadoc a los ficheros de
un proyecto java.
Para instalar JAutodoc en eclipse desde http://jautodoc.sourceforge.net/ o desde eclipse en.
• Help
• Install New Software
• Colocar la direccionhttp://jautodoc.sourceforge.net/update/ como se observa en la imagen.

Ilustración 5: Url de JAutodoc

Ilustración 6: Agregar repositorio de JAutodoc a Eclipse

JAutodoc permite insertar los tag para la...