Yapılandırma dosyamız neden çoğunlukla yorumlardan oluşuyor

Bu sunucudaki .htaccess dosyası 478 satırdan oluşuyor. Bunların 98 tanesi kural. 309 tanesi yorum.

İş gören her satıra üç satır açıklama. Bu oran planlanmadı; bir kural yazmanın kuralı, gerekçenin kuralın hemen yanına yazılması olunca ortaya çıkan şey bu.

Yeniden yazma kuralına neden bir paragraf gerekir

Sunucu yapılandırmasındaki bir kural, sonradan okunmaya alışılmadık ölçüde direnir. Tasarımı gereği kısa ve özdür, adı yoktur, adım adım izlenemez ve tam da doğru adres istenmedikçe etkisi görünmez. Altı ay sonra “bu neden burada” sorusunun tek dürüst yanıtı genellikle bir tahmindir.

Daha kötüsü, yanlış tahmin etmek ucuzdur ve güvenli görünür. Kimsenin anlamadığı bir kuralı er geç biri bir temizlik sırasında siler ve kuralın önlediği sorun geri gelir.

Bu yüzden buradaki her kural, ne işe yaradığını ve nerede denetlenebileceğini yanında taşır. Yorum satırlarından on birinde bir tarih, on ikisinde ölçülmüş bir değer var. Gelecekteki bir okurun, gerekçenin hâlâ geçerli olup olmadığına karar vermesini sağlayan iki şey bunlardır.

Yorumu olmasa ayakta kalamayacak üç kural

Betik uzantısına benzeyen bir dil kodu. Geride kalmış kaynak dosyalarını engelleyen bir kural uzantıya göre eşleşiyordu ve uzantılardan biri de şuydu: .pl — Perl. Tasarım önizlemeleri şöyle adlandırılır: 2900.pl.svg, burada pl Lehçe anlamına gelir. Lehçe önizlemelerin tümü 403 yanıtı vermeye başladı; diğer bütün diller ise sorunsuzdu. Yorum artık, pl uzantısının listede bilerek yer almadığını, nedenini ve hangi gün neyin ölçüldüğünü söylüyor. Bu olmasa, listeyi toparlayan bir sonraki kişi onu geri ekler.

Tek anahtar yeterli görünürken iki anahtar. Önceden sıkıştırılmış dosyalar çıkışta yeniden sıkıştırılmamalıdır. Yapılandırma şunu ayarlıyor: no-gzip, bu da sunucunun iki sıkıştırıcısından birini durduruyor. Diğeri ise başlık hâlâ gzip bildirirken bitmiş dosyayı yeniden sıkıştırdı ve tarayıcılar okunamayan içerik aldı. Yorum, hem no-gzip hem de no-brotli ayarlarının neden birlikte bulunduğunu açıklıyor, çünkü ikincisini kaldırmak bir toparlama gibi görünür.

Ters çevrilmiş bir yasaklama kuralı. Yedek kopyaları engelleyen kural, yasak uzantıları listelemez. Bir dosya adında, sonda olmayan bir kaynak uzantısı bulunup bulunmadığına bakar — böylece henüz kimsenin uydurmadığı adları da yakalar. Yorum, bariz sürümün yanlış ele aldığı beş adı durum kodlarıyla birlikte listeler. Kuralı tek başına okuyunca gereksiz yere zekice görünür; yorumu okuyunca işe yarayan tek çözüm gibi görünür.

Genel hâliyle

Kodu yeniden anlatan yorumlar değersizdir ve bunu herkes bilir. Bunlar öyle yorumlar değil. Kodun kaydedemediğini kaydederler: neyin ters gittiğini, neyin ölçüldüğünü, hangi tarihte ölçüldüğünü ve reddedilen alternatifin ne olduğunu.

Bir yorumun yazılmaya değip değmediğinin testi yeterince basit. Hikâyeyi bilmeyen biri üstündeki satırı silse, bir şey sessizce bozulur muydu? Evetse hikâyeyi yazın. Hayırsa hiçbir şey yazmayın.

Üçe bir oranı bir hedef değil. Neredeyse her satırı belirli bir şey ters gittiği için var olan bir dosyada bu testin ortaya çıkardığı sonuç bu.