Documente el código fuente de su programa con Doxygen
| Tweet |
Para la mayoría de los programadores la codificación de algoritmos es una de las partes más atractivas en la construcción de programas, puesto que trabajamos en el diseño de mundos virtuales, en donde las variables conviven bajo nuestro control. Para crear programas, los programadores hacemos uso de distintas estrategias, como el uso de estructuras de datos y algoritmos avanzados, que facilitan la labor de programación y mantenimiento del programa, asegurándonos de cumplir siempre con 3 políticas de programación como los son: que el programa esté correctamente indentado con las instrucciones debidamente espaciadas, que exista documentación interna y cuente además con la descripción de todos los métodos, funciones y campos de la clase.
Además es necesario agregar que uno de los grandes problemas a los que nos enfrentamos como programadores, es cuando leemos un código ajeno, con la dificultad de comprensión, puesto que entender cómo está organizado el código es una tarea complicada aunque esté comentado, ya que tendremos que pasar entre miles de líneas de código. Inclusive cuando se trata una biblioteca que queremos usar, tenemos que pasar horas leyendo código e intentando entender el porqué de cada archivo de cabecera, de cada archivo fuente, de cada función, cuando en realidad no deseamos saber cómo está implementado sino como usar la biblioteca.
Con tantos aspectos a analizar es necesario tocar temas no relacionados directamente con la programación, como son la documentación, organización y arquitectura. Por ello para aquellos programadores, que están aprendiendo o ya saben lo básico, quiero compartir la solución a los problemas mencionados anteriormente, un software con relación a la documentación de código, se trata de Doxygen.
Doxygen es un proyecto de software libre que analiza el código fuente en busca de directivas en forma de comentarios, de lo contrario el programa no funcionará, para lenguajes C++, C, Java, Objective-C, IDL y en menor medida PHP, C# y D y las convierte en documentación, en múltiples formatos como HTML, LaTeX, RTF, PostScript, PDF o man de Unix. Además esta aplicación tiene un asistente que le ayudará a hacer la documentación del código fuente del programa, aunque también hay opciones para usuarios más avanzados.
Así que ingrese ya al sitio Web y descargue esta aplicación para documentar el código de su programa, digitando la siguiente dirección o a través del siguiente enlace:
www.stack.nl/~dimitri/doxygen
¿Te gusto este POST? ¿Quieres recibir este y mucho mas contenido rápidamente?. Síguenos en Twitter @actualidadgeek, Google Plus o hazte fan de nuestra página en Facebook
