Este documento describe cómo generar documentación API (Application Programming Interface) para una clase Java utilizando la herramienta javadoc. Explica los pasos para crear un archivo Java con comentarios javadoc y luego ejecutar javadoc para generar archivos HTML que documentan la clase. También discute los beneficios de documentar el código y varios conceptos clave relacionados con javadoc.

1. IES Gran Capitán
Módulo: Desarrollo Web en entorno cliente
Ciclo Formativo de Grado Superior “Desarrollo de aplicaciones Web”
<Presentación con clavado>
Fecha entrega: <29/09/2014>
Autores: <Rafael Navarro Prieto>
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://informatica.iesgrancapitan.org informatica@iesgrancapitan.org

2. <Presentación con clavado> 2
1 INTRODUCCIÓN
En esta practica realizaremos un archivo .java, en cual, contiene una clase llamada Presentación
y dentro de esta aparecerán el nombre , apellidos, edad y lugar de nacimiento. Ademas deberá generarse
mediante el comando clavado una documentación en html, en la cual, aparecerá los comentarios escritos
previamente a la creación de la clase Presentación que son: @author @version y breve comentario de la
practica.
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org

3. <Presentación con clavado> 3
2 CREACIÓN DEL ARCHIVO PRESENTACION.JAVA
Nuestro archivo Presentacion.java se deberá construir de la siguiente forma.
Deberemos crear nuestro comentario antes de la creación de la clase, como ya mencionamos
anteriormente, no olvidar las reglas explicadas en la practica anterior como importantes.
3 Compilación de Presentación con clavado
Una vez creado nuestro archivo Presentacion.java nos iremos al símbolo del sistemas o terminal
y procederemos a ejecutar el comando clavado de la siguiente manera:
De esta forma la documentación api se creara mostrando:
1. Autor del documento
2. Versión del notepad++ utilizado
3. Reconocerá las tildes originadas en la documentación api
4. El conjunto de documentos html se generara en la carpeta que he asignado especificando la ruta,
en caso de no existir dicha carpeta el sistema la creara automáticamente.
3.1 Visualización del documento api
Una vez ya tenemos generado el documento api de nuestro aplicación nos deberá generar un
documento html, que para poder visualizar nosotros en nuestro navegador, deberemos abrir el archivo
index.html.
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org

4. <Presentación con clavado> 4
3.1.1 Visualización de los documentos creados
Como ya mencione anteriormente, nos generara un conjunto de archivos html en la carpeta
especificada en el terminal
3.1.2 Visualización del archivo index.html
En esta imagen se puede observar el contenido del archivo index.html y podremos apreciar como
aparece nombre del autor, versión y el nombre de la aplicación ( Presentación con clavado) y se puede
ver como la codificación UTF-8 se ha realizado con la tilde del enunciado
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org

5. <Presentación con clavado> 5
4 PROS Y CONTRAS
Los pros de utilizar clavado es la organización y forma de generar una documentación todas
nuestras clases creadas para que otras personas, que no crearon dichas clases, puedan darle uso a nuestras
clases en sus aplicaciones (si nuestra clase satisface la necesidad de la aplicación).
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org

6. <Presentación con clavado> 6
5 CONCLUSIÓN
Una vez realizada la practica y haber utilizado clavado, se aprende y se le da la importancia al
tema de documentar toda aplicación creada en java dado que, de esta forma, es posible tener un control a
nivel de información de clases y demás componentes de la aplicación. Esto sirve para que otras personas
que puedan utilizar clases creadas por nosotros mismos, puedan utilizar dichas clases viendo el
funcionamiento o explicación que se hace de las clases en esta documentación, de esta forma no es
necesario leer el código fuente de toda la librería donde creemos, en un futuro nuestras clases.
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org

7. <Presentación con clavado> 7
6 CONCEPTOS CLAVE
• -@author: Comentario para escribir el nombre del autor en la aplicación.
• -@version: Comentario que indica la versión de la aplicación, clase, etc generada.
• /** ….... */: Signos que abren y cierran los comentarios que el proceso clavado recoge para
generar los archivos html
• clavado: archivo binario que ejecuta el proceso de documentación de la api
• -d: argumento que se pone en la sintaxis de clavado para especificar la ruta donde se
generaran todos los archivos de la documentación api.
• -encoding UTF-8 -charset UTF-8: Argumentos para crear los archivos html, de forma que
detecte símbolos como las tildes
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org

8. <Presentación con clavado> 8
7 BIBLIOGRAFIA
• IES Gran Capitán. Moodle
Consultado en: http://moodle.iesgrancapitan.org/mod/assignment/view.php?id=3099
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org

9. <Presentación con clavado> 9
8 ÍNDICE
Índice de contenido
1INTRODUCCIÓN.......................................................................................................................................2
2Creacion del archivo Presentacion.java.......................................................................................................3
3Compilacion de Presentacion con javadoc.............................................................................................3
3.1Visualización del documento api........................................................................................................3
3.1.1Visualización de los documentos creados..................................................................................4
3.1.2Visualización del archivo index.html.........................................................................................4
4Pros y contras...............................................................................................................................................5
5Conclusión...................................................................................................................................................6
6CONCEPTOS CLAVE................................................................................................................................7
7BIBLIOGRAFIA.........................................................................................................................................8
8ÍNDICE........................................................................................................................................................9
IES Gran Capitán. C/. Arcos de la Frontera, S/N. 14014 – Córdoba.
http://www.iesgrancapitan.org http://www.iesgrancapitan.org/blog04/ informatica@iesgrancapitan.org