HERRAMIENTA

JAVADOC

DOCENTE:

INTEGRANTES:

CURSO:
TALLER DE
PROGRAMACIÓN

ÍNDIC

CHICLAYO-PERÚ
1
2023
 E
1. Javadoc...................................................................................................................................................

2. Principales etiquetas Javadoc.................................................................................................................

3. Demostración: documentación de archivos java y generación de archivos de documentación

con la herramienta Javadoc.......................................................................................................................

4. Demostración: Configuración y uso de etiquetas de documentación dentro del IDE Java....................

5. Conclusiones...........................................................................................................................................

Referencias............................................................................................................................................................

2
HERRAMIENTA JAVADOC
 1. Javadoc
Es una herramienta esencial del SDK que permite documentar, de una manera rápida y sencilla, las clases y
métodos que se proveen, siendo de gran utilidad para la comprensión del desarrollo ante varios
desarrolladores. Este simplifica la tarea de documentar el código en Java al generar automáticamente
documentación técnica de alta calidad. Cabe recalcar que Javadoc proporciona una API para crear doclets y
taglets, que permite analizar la estructura de una aplicación Java.
Figura 1

Nota: Elaboración propia

Figura 2

Nota: En la imagen se muestra como se ve usado la herramienta JAVADOC. Adaptado de

3
HERRAMIENTA JAVADOC
ZR, C. (s.f.). carloszr.com. Recuperado el 3 de Julio de 2023, de carloszr.com: https://carloszr.com/comentarios-en-java/

2. Principales etiquetas Javadoc

Las principales etiquetas Javadoc que son ampliamente utilizadas para la documentación de código son:
 @author: Se utiliza para especificar el autor del código. Permite identificar quién ha desarrollado o
modificado una clase, método o archivo en particular.
Figura 3

Nota: Elaboración propia

 @version: Se utiliza para especificar la versión del código. Permite indicar la versión actual del
software o biblioteca.
Figura 4

Nota: Elaboración propia.

 @param: Se utiliza para documentar los parámetros de un método. Permite describir el propósito y la
información relevante sobre cada parámetro.
Figura 5

Nota: Elaboración propia.

 @return: Se utiliza para describir el valor de retorno de un método. Proporciona información sobre el
valor que se espera que devuelva el método y su significado.
Figura 6

Nota: Elaboración propia

 @throws o @exception: Se utiliza para documentar las excepciones que puede lanzar un método.
Permite especificar las excepciones que pueden ocurrir y bajo qué circunstancias.
Figura 7

Nota: Elaboración propia

 @see: Se utiliza para establecer referencias a otros elementos relacionados, como clases, métodos o
variables. Puede utilizarse para proporcionar enlaces a documentación adicional o establecer
relaciones entre elementos del código.

4
HERRAMIENTA JAVADOC
 Figura 8

Nota: Elaboración propia

 @since: Se utiliza para indicar desde qué versión del software o biblioteca está disponible un
elemento. Proporciona información sobre la compatibilidad y la disponibilidad del elemento en
diferentes versiones.
Figura 9

Nota: Elaboración propia

 @serial: Se utiliza en Javadoc para documentar la serialización de una clase. Esta etiqueta se aplica a
los campos de instancia que participan en la serialización de objetos.
Figura 10

Nota: Elaboración propia

 @deprecated: Se utiliza para marcar un elemento como obsoleto o desaconsejado. Indica que el
elemento ya no se recomienda utilizar y sugiere buscar una alternativa
Figura 11

Nota: Elaboración propia

3. Demostración: documentación de archivos java y generación

de archivos de documentación con la herramienta Javadoc.
La documentación de archivos Java es una práctica esencial en el desarrollo de software, ya que proporciona
información detallada y comprensible sobre el propósito. Una herramienta ampliamente utilizada para generar
esta documentación es Javadoc. Javadoc es una herramienta integrada en el JDK de Java que extrae
automáticamente los comentarios de documentación del código fuente y genera archivos HTML.
Ahora le diremos el paso a paso para documentar archivos Java y generar archivos de documentación con
Javadoc en IntelliJ IDEA:
Paso 1: Asegúrate de tener instalado IntelliJ IDEA en tu sistema.
Paso 2: Agregar comentarios de documentación
En tu código fuente Java, coloca comentarios especiales de documentación justo antes de la declaración de
una clase que deseas documentar. Estos comentarios comienzan con /** y terminan con */. Asegúrate de que
cada comentario de documentación esté asociado con el elemento correspondiente. Dentro de eso
comentarios, utiliza etiquetas HTML para formatear el texto y proporcionar información estructurada.
Algunas etiquetas comunes incluyen @param, @return, @throws, @see y @deprecated, entre otras.

5
HERRAMIENTA JAVADOC
 Figura 12

Nota: Elaboración propia

Paso 3: Generar la documentación con Javadoc en IntelliJ IDEA

Una de las ventajas de IntelliJ IDEA es que ofrece una integración perfecta con Javadoc. Puedes generar la
documentación directamente desde la IDE siguiendo estos pasos:
Presiona Ctrl + Shift + / (en Windows/Linux) o Cmd + Shift + / (en macOS) para abrir el menú de Javadoc y
Selecciona "Generate Javadoc" en el menú desplegable o busca en la lupita "Generate Javadoc"

Figura 13

Nota: Elaboración propia

Esto generará automáticamente los comentarios de Javadoc para la clase, método o campo seleccionado.
Paso 4: Acceder a la documentación generada

6
HERRAMIENTA JAVADOC
Una vez que hayas generado la documentación, IntelliJ IDEA creará un archivo HTML y una estructura de
carpetas en el directorio del proyecto. También la puedes ver en la carpeta seleccionada anteriormente en el
generador de javadoc.
Figura 14

Nota: Elaboración propia

4. Demostración: Configuración y uso de etiquetas de

documentación dentro del IDE Java.
1) Ponemos las etiquetas de documentación al comienzo de cada clase.

Figura 15

Nota: Elaboración propia

2) Después vemos cuales son los atributos y métodos públicos para dar una etiqueta de documentación.
3) Después entramos en prueba.

Figura 16

Nota: Elaboración propia

7
HERRAMIENTA JAVADOC
 5. Conclusiones
En conclusión, Javadoc es una herramienta ampliamente utilizada en el desarrollo de software en Java.
 Javadoc simplifica la tarea de documentar el código en Java al generar automáticamente
documentación técnica en formato HTML a partir de comentarios especiales agregados al código
fuente.
 La documentación generada por Javadoc proporciona información detallada sobre las clases,
interfaces, métodos y otros elementos del programa, lo que facilita su comprensión y uso por parte de
otros desarrolladores.
 Javadoc utiliza etiquetas predefinidas, para organizar y formatear la documentación generada.
 Javadoc se integra con los IDEs populares, lo que facilita el acceso a la documentación durante el
desarrollo y permite a los desarrolladores consultar rápidamente la información necesaria sobre los
elementos del código.
En conclusión, durante esta investigación se determinó que la herramienta Javadoc trae consigo una
comunicación efectiva, ahorra tiempo y esfuerzo, el mantenimiento simplificado y la compresión más
sencilla contribuyendo a la eficacia en el desarrollo de programas.

Referencias
Baeldung. (s.f.). baeldung.com. Recuperado el 03 de Julio de 2023, de baeldung.com:
https://www.baeldung.com/javadoc
JUNTA DE ANDALUCÍA. (s.f.). juntadeandulancia.com. Recuperado el 03 de Julio de
2023, de juntadeandulancia.com:
https://www.juntadeandalucia.es/servicios/madeja/contenido/recurso/109
picodotdev. (09 de Septiembre de 2017). picodotdev.github.io. Obtenido de
picodotdev.github.io: https://picodotdev.github.io/blog-bitix/2017/09/la-
herramienta-de-documentacion-javadoc-de-java/
ZR, C. (s.f.). carloszr.com. Recuperado el 3 de Julio de 2023, de carloszr.com:
https://carloszr.com/comentarios-en-java/

8
HERRAMIENTA JAVADOC