En el punto 3 (Documentación) se describen algunas de las funcionalidades proporcionadas por la herramienta JavaDoc. Para poner en práctica su uso utilizaremos el IDE Eclipse y el proyecto Semaforo ya utilizado en otras prácticas durante el curso. Para descargar dicho proyecto, pulsa aquí.
Partiendo del código del proyecto Semaforo, se van a incluir una serie de comentarios y etiquetas JavaDoc distribuidos por el proyecto. El código, una vez modificado, está disponible en este enlace: Proyecto semáforo con comentarios.
En la siguiente figura se puede ver el fichero ordenador.java una vez incluidos los comentarios JavaDoc.
Los pasos a seguir son:
- Sobre el código fuente del proyecto, incluir los comentarios JavaDoc que se consideren oportunos.
- Seleccionando el proyecto semaforo, acceder a la función "Generar Javadoc" en la opción de menú Proyecto de la barra de herramientas.
- En la ventana "Generar Javadoc" que aparece, seleccionar como "Mandato javadoc" el ejecutable Javadoc que viene integrado en el paquete jdk e indicar la ruta donde queremos que se guarde la documentación generada.
Una vez generada la documentación, estará disponible en la ruta seleccionada como destino en la ventana anterior. El resultado es una estructura web cuyo fichero de inicio es index.html. Si pulsas aquí te puedes descargar el javaDoc generado.
En la siguiente figura se muestra el aspecto que tiene la documentación generada. En particular, se presenta la clase ordenador del proyecto.
