El archivo de configuración que se explica solo

El .htaccess de este servidor tiene 478 líneas. 98 de ellas son reglas. 309 son comentarios.

Tres líneas de explicación por cada línea que hace algo. Esa proporción no se planeó; es lo que sale cuando la regla para escribir una regla es que el motivo tiene que ir al lado.

Por qué una regla de reescritura necesita un párrafo

Una regla en la configuración de un servidor es insólitamente hostil a que la lean después. Es escueta por diseño, no tiene nombre, no se puede recorrer paso a paso, y su efecto es invisible salvo que pidas justo la dirección correcta. Seis meses después, la única respuesta honesta a „por qué está esto aquí" suele ser una conjetura.

Peor aún: equivocarse al conjeturar es barato y parece seguro. Una regla que nadie entiende es una regla que alguien acaba borrando en una limpieza, y aquello que evitaba vuelve.

Por eso cada regla lleva aquí para qué sirve y dónde se puede comprobar. Once de las líneas de comentario llevan una fecha, doce llevan una cifra medida. Esas son las dos cosas que permiten a un lector futuro decidir si el motivo sigue en pie.

Tres que no sobrevivirían sin su comentario

Un código de idioma que parecía una extensión de script. Una regla que bloqueaba archivos fuente olvidados actuaba por extensión, y una de ellas era .pl — Perl. Las vistas previas de diseños se llaman 2900.pl.svg, donde pl es polaco. Todas las vistas previas polacas empezaron a responder 403 mientras el resto de idiomas iba bien. El comentario dice ahora que pl está deliberadamente fuera de la lista, por qué, y qué se midió qué día. Sin eso, la siguiente persona que ordene la lista lo vuelve a poner.

Dos interruptores donde uno parece bastar. Los archivos precomprimidos no deben comprimirse otra vez al salir. La configuración pone no-gzip, lo que detiene uno de los dos compresores del servidor. El otro volvía a comprimir el archivo terminado mientras la cabecera seguía anunciando gzip, y los navegadores recibían contenido ilegible. El comentario explica por qué están los dos, no-gzip y no-brotli, porque quitar el segundo parece ordenar.

Una regla de denegación que va al revés. La regla que bloquea copias de seguridad no enumera extensiones prohibidas. Pregunta si un nombre de archivo contiene una extensión de código fuente que no esté al final — y así atrapa los nombres que nadie ha inventado todavía. El comentario enumera los cinco nombres en los que la versión obvia se equivocó, con sus códigos de estado. Lee la regla sola y parece innecesariamente lista; lee el comentario y parece lo único que funciona.

La versión general

Los comentarios que repiten el código no valen nada y todo el mundo lo sabe. Estos no son eso. Registran lo que el código no puede: qué salió mal, qué se midió, en qué fecha, y cuál era la alternativa que se descartó.

La prueba de si un comentario merece escribirse es bastante simple. Si alguien que no conoce la historia borrara la línea de encima, ¿se rompería algo en silencio? Si sí, escribe la historia. Si no, no escribas nada.

Tres a uno no es un objetivo. Es lo que dio esa prueba en un archivo donde casi cada línea existe porque algo concreto salió mal.