- Giriş
- İsimlendirme ve standartları
- Girintiler ve aralıklar
- Doğru programlama teknikleri
- Mimari
- ASP.NET
- Yorumlar
- Hata ayıklama
Yorumlar
Anlamlı ve açıklayıcı yorum satırları kodu daha anlamlı kılar ve bakımı kolaylaştırır. Bu noktada dikkat edilmesi gereken hususlar şunlardır.
- Yazılan her koda yorum satırı eklemeye gerek yoktur.
- Yorum satırları için // veya /// işaretlerini kullanın. /*…*/ işaretini kullanmaktan kaçının.
- Sadece gerekli olan yerlere yorum yazın. Bu sayede kodun okunabilirliği sağlanmış olur. Eğer metod ve değişken isimleri yeterince açıklayıcı şekilde seçilirse yorum satırlarına gerek kalmayacaktır.
- Kod yorum satırı olmadan da anlaşılabiliyorsa gereksiz yere yorum yazmayın. Yorum satırlarının dezavantajlarından biri de kod değiştirilip yorum satırı değiştirilmediğinde kafa karışıklığına yol açmasıdır.
- Az satırlı yorumlar kodu daha şık hale getirecektir. Ancak kod temiz, okunabilir değilse ve yorum satırları da yeterli değilse, bu durum da kötüdür.
- Mantıksal açıdan çok karmaşık bir kod varsa yani anlaşılması güç bir mantık kullanılmışsa kilit noktalarda açıklamalar yapmak uygun olacaktır.
- Yazım kurallarına uyan, noktalama işaretleri düzgün yorumlar yazın.
