17 feb. 2011

Documentación y herramientas avanzadas de desarrollo

Taller de Programación Orientada a Objetos 
Semana 4 

Es momento de mostrarles mi avance en cuanto a la documentación que llevo hasta el momento con el código que tengo. Al código aún tengo cosas que corregir, pero ya que el punto a resaltar en esta semana es la documentación, les mostraré como trabaje documentando mi código.

La documentación la he subido a una cuenta de web hosting que cree en Byethost, donde cree un subdominio especial para este blog, donde se encuentra toda las páginas generadas con el javadoc.

> Ir a la Documentación

La documentación la genere con la herramienta javadoc del paquete de Java, esto fue incluyendo comentarios con cierta estructura necesaria para que esta herramienta logrará obtener correctamente los comentarios y parámetros.

En las siguientes imágenes les muestro parte de como esta mi código de momento y en lo que hay que fijarse es como estan escritos los comentarios para las clases y los métodos.






Mis archivos los tengo contenidos en un paquete llamado "proyecto" y desde fuera de la carpeta del paquete, en el terminal escribí lo siguiente para que me generará los archivos html de la documentación.

esteban@esteban:~/Documents/Avance$ javadoc -private proyecto

En mi navegador así es como se ven algunas de las páginas generadas por javadoc, que coinciden con el estilo de la página de la API de Java.




Si desean subir su documentación a una página tal y como lo hice yo, y tienen alguna dificultad, con gusto les ayudaré.

1 comentario:

  1. Eventualmente los métodos van a tener que tener parámetros y valores de salida ;) Por ahora vas bien. 5.

    ResponderEliminar