El orden y el desorden juntos diariamente

Cuando MudSlide alcanzó su primera versión estable no era más que un script con el esqueleto básico de un plugin para WordPress, con funciones para guardar en un archivo XML la descripción de alguna galería de Picasaweb, y con plantillas que darían forma a esa misma información para ser visualizada en un reporte o página. El directorio del plugin en aquellas primeras versiones tenía un archivo de script, un archivo de estilos, un directorio para plantillas, un directorio para la librería de Highslide y un directorio para almacenar los archivos descriptores.

Encontrar algo en aquel entorno era relativamente fácil, así que no hubo necesidad de hacerle ajustes al árbol de directorios por mucho tiempo. Pero cuando MudSlide comenzó a crecer aparecieron nuevas plantillas para varios procesos, se agregó Lytebox a la lista de visualizadores, apareció un mecanismo para facilitar el ingreso de galerías a los posts usando el editor de texto enriquecido y se separaron los archivos de CSS de las plantillas iniciales. Llegó un momento en el que existían 3 directorios de imágenes, 3 directorios de estilos, 2 directorios de plantillas y 3 directorios de scripts, lo que dificultaba cualquier seguimiento al código.

En un desarrollo no muy complejo es posible ubicar todos los elementos que lo componen en un único directorio y aun así entender qué es lo que hace cada archivo, pero cuando se tienen dos o más archivos compartiendo funciones comunes -como fue el caso de MudSlide- se deberán crear directorios que ordenen un poco las cosas. Suponiendo que todo proyecto crecerá con el paso de las versiones, es una buena práctica definir un árbol de directorios descriptivo desde el principio, facilitando el reconocimiento del contenido de cualquier archivo en el proyecto con solo leer su nombre y ubicación.

Regla del orden: peras con peras, manzanas con manzanas, scripts con scripts,
estilos con estilos, imágenes con imágenes, librerías con librerías,
clases con clases, scripts de ajax con scripts de ajax, plantillas con plantillas...

Regla de la ubicación: trata que la combinación 'directorio / nombre' describa el
contenido del archivo, dejando para el directorio raíz un único archivo de código.

Excepción a la regla: aveces usamos frameworks que siguen otras normas en lo tocante
a nombres y ubicación.

Capí­tulos: | Anterior | Prefacio | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Siguiente |