miércoles, 16 de febrero de 2011

Documentación y herramientas avanzadas de desarrollo

Taller de POO
Documentación para el código existente del proyecto y la explicación con ligas y capturas de pantalla sobre cómo fue generado


En mi caso utilizo Doxygen para crear a documentación, explicare paso a paso como se realiza incluyendo capturas de pantalla.


Comentamos nuestro código en xcode como explique en esta entrada




Lo primero que debemos de hacer para generar la documentacion con Doxygen para Objective-C es descargar el .dmg y arrastrarlo a application para que quede instalado, descargalo de esta pagina






Ahora si vamos a generar el doc, abres la aplicación y especificas el directorio de tu proyecto y el directorio donde estará el doc, todo eso en la pestaña Wizard.




 Ahora seleccionas la pestaña Expert del Step 2, y marcas JAVADOC_AUTOBRIEF.



Ahora del submenu Topics, seleccionas Build y luego marcas EXTRACT_ALL




Ahora seleccionas HTML, marcas GENERATE_DOCSET



En LaTeX, deseleccionas GENERATE_LATEX



Ahora le seleccionas Run, luego Run doxygen

Y tu documentación ya esta generada.








Para descargar esto en un .zip en esta pagina


Fuentes:
Documenting Objective-C Part 1 
Documenting Objective-C Part 2 
Doxygen Latest release 



Espero que mi entrada les sea de utilidad a todos aquellos que documentan en Objective-C

2 comentarios:

  1. Je, te los puse en la clase y este era el taller. Consígueta algún webhosting gratis para poder poner el HTML tal cual (me de flojera descargar y descomprimir). Muevo los 5 al taller y vuelvo a ver la clase.

    ResponderEliminar