domingo, 20 de noviembre de 2011

Documentación Técnica

Hola saludos, en esta entrada mostrare como generar documentación técnica con javadoc, que fue el que yo utilice.

Existen varias herramientas que nos permiten auto-generar la documentación técnica, están: Javadoc, Doxygen, Sandcastle, Sphinx entre otros.

Bien yo utilizare javadoc, primero desde el símbolo del sistema buscamos el directorio donde tenemos el proyecto, después una vez encontrado tecleamos javadoc *.java y damos enter.
Escribir *.java quiere decir que incluiremos todos los archivos con dicha extensión.



Después nos vamos al directorio donde están los archivos y abrimos el documento html que se llama "index" el cual nos mostrara toda la información generada con esta herramienta.




Subí la documentación completa del proyecto para descargar:
Documentación Técnica

Les dejo también estos links muy buenos sobre la documentación:

Subestimada Javadoc
Javadoc

No hay comentarios:

Publicar un comentario