Kodlar yorum satırı haline getirilmek yerine doğrudan silinmelidir. Bu kodlar kodu okuyan kişiyi şüpheye düşürüp kafasını karıştırabilir.
Silinen kodlara, ne zaman, hangi istek nedeniyle silindiği bilgisine kaynak kontrol (TFS, GIT) araçlarından daha sonra zaten ulaşabiliriz.
Kod içerinde değişiklik yapan kullanıcı, değişiklik numarası gibi gereksiz bilgiler yorum satırı olarak girilmemelidir.
Kodun içinde yorum satırı gerektirmeyecek, yapılan işin çok net olduğu kodlar için yorum satırı yazılmamalıdır. (//şimdi kayıt ediliyor, //karşılaştırma gibi)
//****************** gibi kodun okunmasını zorlaştıran yorum satırı yazmıyoruz (flowerbox).
Bir metot yazarken, mümkün olduğunca, yorum satırı gerektirmeyecek sadelik ve isimlendirme kullanılmalıdır. Yazılan metot fazlaca yorum satırı gerektiriyor ise, o metodun iyileştirmesi veya yeniden yazımı gündeme alınmalıdır.
Hiç yorum yok:
Yorum Gönder