Una decisión que afecta a todo un proyecto informático es como se organizan los ficheros en carpetas. Esto es por una parte una cuestión de gusto, pero por otra muchas veces una afectada por necesidades técnicas. Así la conclusión más importante es que no hay una forma idónea de organizar los ficheros en directorios. Sólo hay formas más o menos malas. En este artículo queremos repasar qué asuntos hay que tener en cuenta a la hora de crear las carpetas. Hay otro artículo con un ejemplo de un árbol de carpetas.

La estructura de directorios es una de las tareas iniciales de un proyecto. Conviene pensársela bien, porque cambiarla más tarde puede ser complicado. Igualmente importante son los nombres de las carpetas (y ficheros).

Es preferible usar nombres cortos, pero sobre todo significativos y comprensibles. Ficheros y carpetas cuyos nombres no contienen espacios son más fácilmente manejables por una línea de comandos y URLs. Separa palabras con guión bajo en lugar de espacios.

No utilices nombres de fichero con mayúsculas, ya que pueden causar problemas entre Unix y Linux, que distinguen entre mayúsculas y minúsculas, y Microsoft Windows que no lo distingue. Además, cualquier combinación de minúsculas o mayúsculas puede ser fácilmente convertida a sólo minúsculas (o mayúsculas). Algo útil a la hora de convertir palabras de búsqueda o argumentos de la línea de comando a ficheros.

La palabra “proyecto” se usa de forma ambigua. Un proyecto por parte de la empresa (y tu trabajo) es un conjunto de aplicaciones que debes programar. Sin embargo, cada aplicación se llama “proyecto” en tu editor, mientras el conjunto de todos estos proyectos se llama “solución” o “workspace” según el editor. Aquí usamos la palabra “proyecto” en el sentido de la empresa, es decir, tu carpeta raíz de proyecto se refiere a un workspace en tu IDE. Cada aplicación se llamará “subproyecto” o “aplicación”.

Hay muchos criterios a tener en cuenta a la hora de crear la estructura de directorios. Aquí viene una colección no completa.

  • En general es preferible tener a todos los carpetas por debajo de un directorio raíz del proyecto. Esto no siempre es posible. En sistemas Linux se distribuyen diferentes ficheros a carpetas de sistema diferentes – como “include” o “lib”. O una parte de los ficheros estará en un web host. Considera la posibilidad de mantener todos los ficheros por debajo del directorio raíz y copiarlos con un shell script a su destino final. Esto puede ser un paso de post-compilación.
  • Si  una parte de los ficheros será pública – en un web host o un API dentro  una carpeta “include”, entonces el proyecto ya debería tener esta estructura. Idealmente se podría copiar la carpeta pública al servidor host con un solo comando. Por ejemplo, todos los ficheros que estarán en el servidor web se encuentran en una carpeta “web_document_root”.
  • Separa las carpetas bajo control de versiones de las que no. No mezcles código fuente con ficheros generados. Aunque no te quedes sólo con los ficheros fuente cuando archives el proyecto. Quizá no funcionará el compilador en diez años. (Y ya verás como diez años pasan…)
  • Separa bien subproyectos para evitar dependencias. Una biblioteca podría servir para otro proyecto y debería estar claro de que más subproyectos depende.
  • Guarda bibliotecas externas en una carpeta especial. Conviene quedarse con el nombre de la biblioteca y la versión, por ejemplo “boost_1_42_0” para la versión 1.42.0 de la biblioteca Boost. Es importante saber la versión y tener la posibilidad de tener varias versiones de la biblioteca externa integradas en el proyecto. Nunca sabes cuándo adaptas tu código a la nueva versión de la biblioteca y si adaptas todo o sólo una parte. Como puede ser difícil conseguir una versión vieja, guarda las bibliotecas externas junto con tu código aunque necesites guardarla varias veces. Al precio de discos duros de hoy es más barato que pasarse un día buscando bibliotecas por ahí cuando toca un cambio en algunos años. Además, da mucha frustración deber entender un proyecto viejo y directamente no funciona o ni siquiera compila.
  • Crea una carpeta para la documentación editada y otra para la generada (por doxygen, javadoc o phpDocumentor. Ten en cuenta que la documentación generada puede crearse en varios formatos como HTML o LaTeX. Una forma de poner orden podría ser:
    • generated_doc –  La carpeta raíz de la documentación generada, contiene enlaces a la página principal index.html guardado en la carpeta “html”.
      • nombre_proyecto – El nombre del subproyecto
        • html – Un carpeta creada por la herramienta de documentación automatizada.

    De esta forma

    • Distinguimos fácilmente la documentación escrita (por un procesador de texto) de la generada.
    • Podemos, mediante enlaces a ficheros, acceder fácilmente a la documentación generada sin preocuparnos de cómo está guardada dentro de la carpeta “html”.
    • Será fácil limpiar una documentación vieja, ya que sólo necesitamos limpiar el contenido la carpeta nombre_proyecto.
  • Crea las carpetas (vacías) para los ficheros temporales que tus aplicaciones podrían generar. No guardes otra cosa ahí de forma que se pueda borrar todo su contenido sin borrar a nada importante.
  • Si una aplicación se comunica mediante ficheros, crea una carpeta entrada_mi_aplicación en que solo lee una aplicación. Así simplemente puede comprobar si hay fichero o no para procesarlo. La carpeta “salida” sería la “entrada” de otra aplicación.
  • Crea una carpeta para ficheros que sirven como base de datos, por ejemplo las imágenes subidas a un servidor web.
  • Puedes reunir las carpetas con datos temporales, de entrada y de base de datos en una carpeta de datos de aplicación. También puedes crear dentro la carpeta de cada tipo de información subcarpetas para cada aplicación.
  • Si usas una base de datos como MySQL, guarda backups en SQL junto con tu proyecto. Los ficheros que usa la base de datos en sí muchas veces no son tan fáciles a mover. Aparte de esto es probable que se comparte una base de datos entre varios proyecto y conviene no guardarla por debajo de una carpeta raíz del proyecto.
  • En tu proyecto puede tener también una carpeta para versiones viejas. Sin embargo, en este caso podría convenir crear una carpeta de proyecto nuevo.
  • Crea una carpeta para la configuración de la aplicación. Con esto nos referimos a ficheros que contienen el mismo tipo de datos, pero que se debe editar a mano para adaptarla a la plataforma o la máquina. Por ejemplo, el fichero “ip.ini” podría contener direcciones IP a usar por el programa. Es importante separar estos ficheros del programa porque la actualización del programa y la configuración de las máquinas en que corre son actividades independientes.

En fin hemos visto que son muchos los aspectos a tener en cuenta. Muchas veces es la experiencia que dice qué estructura es la que más conviene. Lo más práctico es copiar una carpeta cuando hace falta copiar algo y que esta carpeta ya contenga todo lo que será necesario. Cuando nos toca copiar varias carpetas en sitios diferentes, entonces sabemos que algo podemos hacer mejor.

Referencias

About these ads