İyi yorumlar kodu anlaşılır kılar; kötü yorumlar ise karışıklık yaratır. Amaç, 'neden'i açıklamaktır.

'Neden'i açıkla, 'ne'yi değil

Kodun ne yaptığı bariz; neden öyle yaptığın değerlidir.

# YANLIS: i'yi 1 artir
i += 1
# DOGRU: siradaki ogrenciye gec
i += 1

Karmaşık bölümleri açıkla

Anlaşılması zor bir formül veya mantık varsa kısaca not düş.

İpuçları

  • Kodun kendisi açıksa, çok yoruma gerek kalmaz.
  • Eski, yanlış yorumlar kod kadar zararlı olabilir; güncel tut.
  • Yorumları kısa ve öz yaz.

Kuzey Kutbu dersleriyle kendi elinle yazarak öğren.