Actividad de la Cuarta Semana

Documentación y Herramientas de Desarrollo

La herramienta que he elegido es JAVADOC

Descripción:
Javadoc es una herramienta para la generación de documentación de API'S (Interfaz de programación de aplicaciones) en formato HTML a partir de código fuente JAVA.

Descarga de la herramienta:
Javadoc puede ser descargado solamente como parte del paquete Java JDK o SDK. La liga de descarga es la siguiente:
https://cds.sun.com/is-bin/INTERSHOP.enfinity/WFS/CDS-CDS_Developer-Site/en_US/-/USD/ViewProductDetail-Start?ProductRef=jdk-6u22-oth-JPR@CDS-CDS_Developer

Tutoriales de la herramienta:
http://www.mcs.csueastbay.edu/~billard/se/cs3340/ex7/javadoctutorial.html
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Para ejemplificar la utilización de Javadoc tomaremos como base el programa de la semana pasada, el programa de Bicycle, aquí esta el código de dicho programa:

Codigo javadoc

View more documents from Jaziel Torres.

Donde podemos observar que:

• los comentarios van en el formato /** Comentario */
• utilizamos varios como @author (que especifica el autor de la clase), @param (que especifica los parametros del método),  @version (muestra la version de la clase),  @since (donde ponemos la version de java que utilizamos), @see(es un link a alguna variable/parametro/metodo de la clase), @deprecated(nos muestra que un metodo fue reemplazado).

Para ejecutar javadoc, lo podemos hacer desde nuestra consola cmd desde windows posicionandonos en la carpeta del JDK instalado en el directorio /bin, ahi ejecutamos esta sentencia:
javadoc -author -version Bicycle.java
El -author y -version es para que nos traiga el author y la version que no se generan por defecto.

Al hacer esto inmediatamente despues nos genera un  Html en la carpeta raiz de Java, con la documentación:

Y aqui vemos como se transladan los comentarios y los tags de la clase hacia el HTML generado:

Los tags author, version y since se pasaron así

Los comentarios y el tag deprecated

Los tags see y deprecated ademas de los comentarios