Yorumlar tek satırlı olabilir: // ile başlayan ve çok satırlı: /* … */.
Normalde bunları kodun nasıl ve neden çalıştığını açıklamak için kullanırız.
İlk bakışta yorum yapmak açık olabilir, ancak programlamada acemiler genellikle bunları yanlış kullanır.
Kötü yorum satırları
Acemiler, “kodda neler olduğunu” açıklamak için yorumları kullanma eğilimindedir. Bunun gibi:
Ancak iyi bir kodda, bu tür “açıklayıcı” yorumların miktarı minimum olmalıdır. Cidden, kodun onlar olmadan anlaşılması kolay olmalıdır.
Bununla ilgili harika bir kural var: ”Kod, yorum gerektirecek kadar net değilse, belki de bunun yerine yeniden yazılmalıdır.”
İyi yorum satırları
Bu nedenle, açıklayıcı yorumlar genellikle kötüdür. Hangi yorumlar güzel?
Mimariyi tanımlayın
Bileşenlere, bunların nasıl etkileşime girdiğine, çeşitli durumlarda kontrol akışının ne olduğuna dair üst düzey bir genel bakış sağlayın… Kısacası – kodun kuş bakışı görünümü.
Belge işlevi parametreleri ve kullanımı
Bu tür yorumlar, fonksiyonun amacını anlamamızı ve koduna bakmadan doğru şekilde kullanmamızı sağlar.
Görev neden bu şekilde çözüldü?
yazılanlar önemlidir. Ancak yazılmayanlar, neler olup bittiğini anlamak için daha da önemli olabilir. Görev neden tam olarak bu şekilde çözüldü? Kod cevap vermiyor.
Görevi çözmenin birçok yolu varsa, neden bu? Özellikle de en bariz olanı olmadığında.
Bu tür yorumlar olmadan aşağıdaki durum mümkündür:
1. Siz (veya meslektaşınız) bir süre önce yazılmış kodu açın ve “yetersiz” olduğunu görün.
2. “O zamanlar ne kadar aptaldım ve şimdi ne kadar akıllıyım” diye düşünüyorsunuz ve “daha açık ve doğru” değişkenini kullanarak yeniden yazın.
3. Yeniden yazma isteği iyiydi. Ancak bu süreçte “daha bariz” çözümün aslında eksik olduğunu görüyorsunuz. Nedenini belli belirsiz hatırlıyorsun, çünkü bunu çoktan denemiştin. Doğru değişkene geri döndünüz, ancak zaman boşa gitti.
Çözümü anlatan yorumlar çok önemli. Gelişimin doğru şekilde devam etmesine yardımcı olurlar.