En el artículo “Como organizar ficheros en carpetas” ya he descrito criterios a tener en cuenta a la hora de crear las carpetas de un proyecto informático. En este artículo quiero dar un ejemplo real con comentarios de como se pueden organizar las carpetas en el caso concreto de una aplicación en C++. Aunque se trata de un caso concreto, aporta muchas ideas que se pueden generalizar.

Presento las carpetas en formato de árbol. Es el formato habitual para mostrar una estructura de carpetas, sin embargo aleja mucho los elementos principales de la carpeta raíz que, por lo tanto, se ven más difícilmente en su conjunto. Sin embargo, creo que será suficiente tener este problema en mente.

Los nombres propuestos para cada carpeta aparecen en cursiva. Están en inglés, pero se pueden cambiar según conveniencia. Los nombres de las carpetas usan el guión bajo ‘_’ en lugar de espacios para nombres compuestos por varias palabras. Conviene no usar espacios en las rutas de ficheros, ya que pueden complicar el procesamiento.

Todo lo relacionado con el proyecto se encuentra en una carpeta raíz.

  • cfg: Ficheros de configuración cuyos contenidos dependen de la máquina en que corre el programa. Normalmente sólo habrá uno que contiene información como la dirección IP o el nombre del equipo en la red. Se debería guardar un fichero de configuración por defecto en la carpeta code.
  • code: La carpeta que contiene los ficheros fuentes y es la carpeta raíz para un control de versiones.
    • mi_lib: Cada biblioteca tiene su propia carpeta. El nombre de la carpeta se ajusta lógicamente a lo que hace la biblioteca. Conviene usar un nombre corto que puede usarse como prefijo en los nombres de los ficheros fuentes. También es posible sólo añadir el directorio code a la ruta de inclusiones y incluir los ficheros mediante una ruta relativa como #include "mi_lib/include/mi_cabecera.h". En Java, las carpetas deben tener el nombre del paquete a que corresponden.
      • doc: Ficheros de documentación y tutoriales a compilar junto con la documentación de los ficheros de código por el sistema de documentación automático. La documentación en esta carpeta completa el manual de referencia creado a partir de los ficheros fuente del programa.
      • include: Ficheros de inclusión y otros ficheros públicos.
      • lib: Ficheros “cpp” en C++ u otros ficheros privados. También es habitual llamar esta carpeta src. Yo prefiero no usar este nombre ya que todo dentro de la carpeta code es “source”. De hecho, la carpeta code se podría llamar source.
    • main: Para el programa principal también hay una carpeta. Esta tiene la misma estructura que las demás. En lugar de main se puede usar el nombre del programa como nombre de carpeta. Si tengo varios ejecutables, entonces conviene tener una carpeta main en cuya subcarpeta doc se encuentra la documentación del proyecto y donde se hace referencia a todos los ejecutables y bibliotecas del proyecto – en fin sobre todas las subcarpetas de la carpeta code.
      • cfg: Una carpeta adicional para el programa principal puede ser una carpeta con ficheros patrones para la configuración de la máquina. Estos ficheros se copian a la carpeta cfg y se modifican para la máquina del programador.
    • project: Esta es la carpeta contiene los ficheros creados por el IDE. Cuando añades la carpeta code al control de versiones deberás borrar algunos ficheros no fuentes creados por el IDE. Los nombres de estos ficheros son diferentes para cada IDE.
      • Eclipse: Se usas varios IDE, entonces crea una subcarpeta para cada uno. Eclipse sería un nombre adecuado para el IDE Eclipse. Puede haber otros nombres como NetBeans o VisualStudio. Si no te gustan los entornos gráficos puedes crear una carpeta makefile para ser usado desde una consola.
  • compiled: Todos los ficheros generados. La idea es poder borrar el contenido de esta carpeta por completo para hacer “limpieza”.
    • generated_doc: Documentación generada por sistema de documentación automáticos.
      • html: Esta carpeta crea doxygen para el formato HTML. Habrá más carpetas para otros formatos de documentación como LaTeX.
    • gcc: Una carpeta para cada compilador que se usa. Si sólo uso un compilador, entonces este nivel de carpeta no es necesario.
      • Debug: El compilador de C++ suele crear una carpeta para cada configuración. Una suele llamarse “Debug” y otra “Release”. Puede haber más carpetas para más configuraciones; por ejemplo para enlaces con diferentes bibliotecas.
        • exe: La carpeta de ejecutables contiene todos los ficheros binarios necesarios para utilizar el programa compilado. Puede haber ficheros de configuración por defecto que meramente se necesitan copiar. ¡Incluye esta copia en el makefile! Para una aplicación java, se puede considerar usar el nombre jar en lugar de exe.
        • obj: Ficheros intermedios creado por el compilador y no necesarios para la ejecución del programa. En Java, esta carpeta podría denominarse class.
  • ext: Bibliotecas externas. Cada componente tiene una carpeta propia. Es importante archivar la biblioteca externa junto con el proyecto, ya que una versión más moderna quizá no funcionará con el código propio. Para reducir el uso del disco duro puede ser útil guardar las bibliotecas externas físicamente en una carpeta común y hacerlas aparecer en la carpeta ext mediante un enlace (soft link) del sistema operativo (con el comando ln en Unix.)
  • io: Carpeta principal para ficheros temporales y de entrada y salida del programa. Se entiende que se pueden borrar todos estos ficheros sin perjuicio al funcionamiento del programa. En un entorno real, las subcarpetas de io pueden encontrarse en otros directorios. Esto se debería poder ajustar con los ficheros en la carpeta cfg. Para hacer pruebas sin ensuciar al resto del disco duro, se aprovecha la carpeta io dentro de la carpeta raíz del proyecto. Para archivar un proyecto no haría falta guardar los ficheros dentro de la carpeta io – sólo la estructura de los directorios.
    • in: Ficheros de entrada al sistema. Es la responsabilidad del programa de borrar los ficheros procesados.
    • out: Fichero de salida del sistema.  Es la responsabilidad del programa de no sobrescribir ficheros todavía no procesados. No es su responsabilidad de borrarlos, ya que esto haría el sistema que recibe los ficheros. En un sistema real, la carpeta out sería la carpeta in del sistema siguiente.
    • temp: Ficheros temporales del programa. Es la responsabilidad del programa de borrar los ficheros. Es la responsabilidad del programador que sólo el programa deja sus ficheros ahí y que pueda limpiar la carpeta con un simple “borra todo”.
    • trace: Conviene tener una carpeta especial para trazas.
  • documentation: Documentación que ni es generada ni un código fuente para un sistema de documentación automatizado. Estos son ficheros Word, Excel, PDF, imágenes, emails y cualquier otro editado y procesado por una mente humana.
    • emails: Correos electrónicos con el cliente y otras personas involucradas. No guardes todos los emails aquí. Sólo aquellos que documentan cambios en los demás documentos.
    • manuals: Manuales de usuario o de referencia editado por un ser humano. Aquellos creados por un un sistema de documentación automático se encuentran en la subcarpeta generated_doc de la carpeta compiled.
    • specification: La especificación del proyecto. Para proyectos grandes es importante separar la especificación de otra documentación ya que los ingenieros de prueba usan meramente la especificación para comprobar que un software cumple los requisitos.

Por la longitud del artículo se nota que la creación de un árbol de carpetas para un proyecto no es trivial. Aún así todavía faltan carpetas que pueden ser importantes como una web_doc_root para un proyecto de páginas web. Pero, en fin, es sólo un ejemplo.

Referencias

Anuncios