Zašto se naša konfiguracijska datoteka uglavnom sastoji od komentara
O sadržaju i njegovoj provjeri
U ovom članku
Datoteka .htaccess na ovom poslužitelju ima 478 redaka. Od toga je 98 pravila, a 309 komentara.
Tri retka objašnjenja za svaki redak koji nešto radi. Taj omjer nije planiran; nastaje kada je pravilo za pisanje pravila da razlog mora stajati uz njega.
Zašto pravilo prepisivanja treba odlomak
Pravilo u konfiguraciji poslužitelja neobično je nepristupačno kasnijem čitanju. Namjerno je sažeto, nema naziv, ne može se izvršavati korak po korak, a učinak je nevidljiv osim ako se zatraži upravo prava adresa. Šest mjeseci kasnije jedini iskren odgovor na „zašto je ovo ovdje“ obično je nagađanje.
Još gore, pogrešno nagađanje jeftino je i izgleda sigurno. Pravilo koje nitko ne razumije pravilo je koje netko na kraju izbriše pri pospremanju i vraća se ono što je sprječavalo.
Zato svako ovdašnje pravilo nosi svoju svrhu i mjesto gdje se može provjeriti. Jedanaest redaka komentara nosi datum, dvanaest izmjerenu brojku. To su dvije stvari koje budućem čitatelju omogućuju odluku vrijedi li razlog još.
Tri pravila koja ne bi preživjela bez komentara
Jezični kod koji je izgledao kao skriptni nastavak. Pravilo koje blokira zaostale izvorne datoteke prepoznavalo je nastavke, a jedan od njih bio je .pl — Perl. Pretpregledi dizajna nazivaju se 2900.pl.svg, gdje pl znači poljski. Svaki poljski pretpregled počeo je odgovarati s 403 dok su svi drugi jezici bili u redu. Komentar sada kaže da pl namjerno nije na popisu, zašto i što je izmjereno kojeg dana. Bez toga ga sljedeća osoba koja posprema popis vraća.
Dva prekidača ondje gdje jedan izgleda dovoljan. Unaprijed komprimirane datoteke ne smiju se ponovno komprimirati pri isporuci. Konfiguracija postavlja no-gzip, što zaustavlja jedan od dvaju kompresora poslužitelja. Drugi je ponovno komprimirao gotovu datoteku dok je zaglavlje i dalje najavljivalo gzip, a preglednici su dobivali nečitljiv sadržaj. Komentar objašnjava zašto su ondje i no-gzip i no-brotli jer uklanjanje drugog izgleda kao pospremanje.
Obrnuto pravilo zabrane. Pravilo koje blokira sigurnosne kopije ne nabraja zabranjene nastavke. Pita sadržava li naziv datoteke izvorni nastavak koji nije na kraju — čime otkriva nazive koje još nitko nije izmislio. Komentar nabraja pet naziva kod kojih je očita verzija pogriješila, uz njihove statusne kodove. Pročitajte samo pravilo i izgleda nepotrebno domišljato; pročitajte komentar i izgleda kao jedino što radi.
Opća verzija
Komentari koji ponavljaju kod bezvrijedni su i svi to znaju. Ovi nisu takvi. Bilježe ono što kod ne može: što je pošlo po zlu, što je izmjereno, kojeg datuma i koja je druga mogućnost odbačena.
Test vrijedi li komentar napisati dovoljno je jednostavan. Bi li se nešto neprimjetno pokvarilo kad bi netko tko ne zna priču izbrisao redak iznad njega? Ako bi, zapišite priču. Ako ne bi, nemojte ništa pisati.
Tri prema jedan nije cilj. To je rezultat tog testa na datoteci u kojoj gotovo svaki redak postoji jer je nešto konkretno pošlo po zlu.