Clean Code: Okunabilirlik

Kod okunabilirliği, yazılım geliştiricilerin yazdığı kodun diğer geliştiriciler tarafından kolayca okunabilmesini ve anlaşılabilmesini ifade eder. Okunabilir kod, yazılım projelerinin bakımını ve genişletilmesini kolaylaştırır.

Önemi

Okunabilir kod, yazılım geliştirme sürecinde büyük bir öneme sahiptir. Geliştirici ekipler zamanla değişebilir ve kod üzerinde yapılan değişiklikler hızla anlaşılabilmelidir. Okunabilir olmayan kod, hata yapma olasılığını artırır ve geliştirme sürecini yavaşlatır.

İyi Uygulamalar

• Yapılandırılmış ve Tutarlı Format: Kodun tutarlı bir formatta yazılması, okunabilirliği artırır. Kod biçimlendirme kurallarına uyulmalıdır.
• Anlamlı İsimlendirme: Değişken, fonksiyon ve sınıf isimlerinin anlamlı ve açıklayıcı olması gerekir.
• Kısa ve Net Fonksiyonlar: Fonksiyonlar tek bir işi yapacak şekilde tasarlanmalıdır. Kısa ve öz fonksiyonlar, kodun anlaşılmasını kolaylaştırır.
• Yorum Kullanımı: Yorumlar, kodun amacını ve işleyişini açıklamalıdır. Gereksiz yorumlardan kaçınılmalıdır.

Örnek

// Kötü Örnek
void p()
{
    int d = 0;
    foreach (var i in c)
    {
        d += i.Amount;
    }
    Console.WriteLine(d);
}

// İyi Örnek
void PrintTotalAmount()
{
    int totalAmount = 0;
    foreach (var item in collection)
    {
        totalAmount += item.Amount;
    }
    Console.WriteLine(totalAmount);
}