Documentación

La documentación de los programas es un aspecto sumamente importante, tanto en el desarrollo de la aplicación como en el mantenimiento de la misma. Mucha gente no hace este parte del desarrollo y no se da cuenta de que pierde la posibilidad de la reutilización de parte del programa en otras aplicaciones, sin necesidad de conocerse el código al dedillo. 

La documentación de un programa empieza a la vez que la construcción del mismo y finaliza justo antes de la entrega del programa o aplicación al cliente. Así mismo, la documentación que se entrega al cliente tendrá que coincidir con la versión final de los programas que componen la aplicación. 

Una vez concluido el programa, los documentos que se deben entregar son una guía técnica, una guía de uso y de instalación. 


En mi documentación utilice el Doxygen:

Doxygen es un generador de documentación para C++, C, Java, Objective-C, Python, IDL (versiones Corba y Microsoft) y en cierta medida para PHP, C# y D. Dado que es fácilmente adaptable, funciona en la mayoría de sistemas Unix así como en Windows y Mac OS X. La mayor parte del código de Doxygen está escrita por Dimitri van Heesch.

Aquí la documentación hecha con el Doxygen:

Aquí lo deje muy simple por que mi proyecto tiene muy pocas clases, el código es muy corto, ademas que aun mis clases son muy simples.

Me encanto la documentación, es una muy buena forma de aprender...