Temiz Kod Nedir ve Neden Önemlidir?
Temiz kod (clean code), yalnızca bilgisayar tarafından sorunsuz derlenip çalıştırılan kod değil; aynı zamanda geliştiriciler tarafından kolayca okunabilen, anlaşılabilen, test edilebilen ve genişletilebilen koddur. Ortak adlandırma ve biçimlendirme kuralları, ekip üyelerinin aynı dosyada çalışmasını kolaylaştırmayı amaçlar. Stil uyumu tek başına doğru, güvenli veya hızlı çalışan bir yazılım garantisi değildir.
PHP Topluluk Standartları: PSR-1 ve PSR-12
PHP Framework Interop Group (PHP-FIG) tarafından tanımlanan PHP Standard Recommendations (PSR), sektörde ortak bir dil oluşturur. Bu standartlar arasında iki temel kılavuz öne çıkar:
- PSR-1: Temel Kodlama Standardı: Sınıf isimlerinin StudlyCaps / PascalCase formatında tanımlanmasını, sınıf sabitlerinin tamamının büyük harfle ve alt tire ayrımıyla yazılmasını, metot isimlerinin ise camelCase olarak bildirilmesini şart koşar. Dosyalarda PHP kodu için BOM içermeyen UTF-8 kullanımını da belirtir. Kapanış etiketinin yalnız PHP dosyalarında atlanması ise PSR-12 kuralıdır.
- PSR-12: Genişletilmiş Kod Stili Kılavuzu: Dosyaların yalnızca Unix LF satır sonu ile bitmesini, kod bloklarında 4 boşluklu girintileme yapılmasını ve görünürlük bildirimlerinin (public, protected, private) metot ile özelliklerde açıkça belirtilmesini kurala bağlar. Sadece PHP içeren dosyalarda kapanış etiketinin (?>) kesinlikle atlanması gerektiğini belirtir.
Stil Kuralını Projeye Uygulamak
PSR kuralları, bu standartlara uyum hedefleyen projeler için somut bir ortak çerçevedir; her PHP programının çalışması için dilin zorunlu tuttuğu sözdizimi kurallarıyla aynı şey değildir. Önce ekibin hangi standardı benimsediğini ve desteklenen PHP sürümlerini belirleyin. Sonra küçük bir değişiklikte biçimlendirme aracının önerilerini inceleyin; büyük bir dosyayı yalnız stil nedeniyle değiştirmek kod incelemesini gereksiz yere zorlaştırabilir.
Örneğin bir sipariş sınıfına yeni yöntem eklerken çevredeki adlandırmayla uyumlu, amacı açık bir isim seçebilirsiniz. Girintiyi dört boşlukla korumak stil denetimini kolaylaştırır; yöntemin doğru tutarı hesapladığını ise anlamlı bir davranış kontrolüyle ayrıca doğrulamak gerekir. Biçimlendirme aracı bu iş kuralının doğruluğunu belirleyemez.
Temiz Kod İçin Adım Adım Kontrol Listesi
- Editör önerisi olarak fonksiyonun amacını net tutun ve yaptığı işi anlaşılır biçimde adlandırın.
- Koşulların okunabilirliğini inceleyin; erken dönüş gibi seçenekleri mevcut davranışı koruyarak değerlendirin.
- PHP_CodeSniffer ve PHP-CS-Fixer gibi araçları geliştirme ortamınıza ve sürüm kontrol süreçlerinize (pre-commit) dahil ederek stil hatalarını otomatik denetleyin.
- Stil değişikliklerinden sonra projenin ilgili doğrulamalarını çalıştırın; davranışı değiştiren düzenlemeleri ayrıca inceleyin.
Sıkça Sorulan Sorular
Temiz kod yazmak neden bir zaman kaybı değildir?
Geliştirme sürecinin başlangıcında doğru isimlendirmeler yapmak ve modüler yapılar kurgulamak ilk etapta birkaç dakika fazla vakit alabilir. Kazanım projenin yapısına ve ekip alışkanlıklarına bağlıdır. Amaç, kodu sonradan okuyacak kişinin sorumlulukları ve veri akışını daha kolay izlemesidir.
