Clean Code: Yorum Satırları ve Dokümantasyon

Yorumlar ve Dokümantasyon, kodun ne yaptığını ve nasıl çalıştığını açıklar. Kodun nasıl kullanılacağını ve işleyişini açıklayan dokümantasyonlar yazılmalıdır. İşler devam ettikçe, yorumlar ve dokümantasyonlar güncellenmelidir.

Önemi

Yazılan yorumlar ve dokümanlar, kodun anlaşılmasını ve bakımını kolaylaştırır. İyi yazılmış yorumlar ve dokümantasyon, geliştiricilerin projeye adapte olmasını sağlar.

İyi Uygulamalar

• Açıklayıcı Yorumlar: Yorumlar, kodun ne yaptığını ve neden yaptığını açıklamalıdır.
• Gereksiz Yorumlardan Kaçınma: Kodun kendisi yeterince açıklayıcı olmalıdır; gereksiz yorumlar kodu kalabalıklaştırır.
• Dokümantasyon: Kodun nasıl kullanılacağını ve işleyişini açıklayan ayrıntılı dokümantasyonlar yazılmalıdır.
• Yorumların Güncellenmesi: Kod değiştikçe yorumların ve dokümantasyonun da güncellenmesi gereklidir.

Örnek

// Kötü Örnek
// Bu fonksiyon kullanıcıyı kaydeder
void SaveUser(User user)
{
    // kod
}

// İyi Örnek
///
/// Bu fonksiyon, verilen kullanıcıyı veritabanına kaydeder.
/// 
///Kaydedilecek kullanıcı nesnesi void RegisterUser(User user) { // kod }