Entradas

Mostrando entradas de octubre, 2010

[Documentación de Software] Doxygen - Parte 2

Estuve investigando un poco más acerca de Doxygen, y aprendí a utilizarlo. Más adelante voy a subir un video-tutorial. Por el momento, doy una explicación rápida. Para que Doxygen te genera la documentación de forma correcta, hay que tener cierto formato para comentar los métodos, las clases, etcétera. Explicaré ese formato a través de unos ejemplos: class Persona { public: //! Descripción corta. /** Descripción detallada/larga. * \param abc: Parámetro que sirve para ... * \return Retorna a ... */ int A(int abc); /** * \brief Descripción corta. * * Descripción detallada. Este formato es equivalente al de arriba. * * @param cba: ... * @return Retorna a la nada misma... */ int B(int cba); }; Este formato se usa tanto para describir clases, como para describir métodos, archivos, etc. Además de "param", "brief", y "return", exis

[Documentación de Software] Doxygen

Doxygen es una herramienta que permite especificar y documentar el código fuente del software que se esté programando. Documentar software es algo fundamental que cada programador debería realizar. Yo programo desde hace varios años, y sé por experiencia que documentar el código fuente es muy importante. Me pasaba antes, en mis inicios en la programación, que estaba con infinitas ideas y comenzaba un proyecto, luego de un tiempo lo "pausaba" y comenzaba otro, y así sucesivamente. Luego de un tiempo, cuando quería volver al primero, se me complicaba muchísimo porque tenía que mirar el código para entender qué había hecho, para qué servía cada función, etc. Desde que empezé a documentar el software, ya no tengo ese problema. Doxygen soporta varios lenguajes: C, C++, C#, Java, Objetive C, Python, PHP e IDL. Y además, es multiplataforma. Se puede descargar gratuitamente desde su página oficial:  http://www.stack.nl/~dimitri/doxygen/index.html

[C/C++ IDE] Code Blocks - Instalación en Windows y Ubuntu

Code Blocks es un entorno de desarrollo para el lenguaje C y C++. Es multiplataforma, tiene un motor dinámico de plugins, acepta varios compiladores (como el de Visual Studio o MinGW), etc. No me voy a detener en la descripción, los interesados pueden ver más información en wikipedia a través de este link . Para instalarlo en Window s: - Instalación Entrar en la página de Code::Blocks . Ir a Downloads , y luego a Binary releases . Ahí se ven dos enlaces de descarga, uno que dice codeblocks-10.05mingw-setup.exe y el otro que dice codeblocks-10.05-setup.exe . La diferencia entre estos dos es que el que dice MinGW viene con un compilador integrado, mientras que el que no dice contiene solamente el IDE, y nosotros nos tenemos que encargar de instalar y configurar un compilador. Instalarlo como a cualquier programa de Windows. Al abrirlo, si pide seleccionar un compilador, elegir MinGW . Y listo, ya tenemos el IDE instalado, ahora hay que proseguir con la actualización del mismo.