Yazdığınız kodlara yorum eklemek her zaman iyi olmayabilir, özellikle her satırı açıklayıcı ve yanlış yorum anahtarı kullanmak kodun okunurluğunu da azaltacaktır, bu yüzden yorum yaparken dikkat etmelisiniz.
Kural 1- Tek satırlık yorumlarda // ile başlayanlar kullanmak yerine (/* ... */) kullanılmalıdır. Göze daha fazla hitap edecektir.
Örnek:
/*Bu bir tek satırlık yorum örneğidir.*/
Kural 2- Tek satırlık tek tek yorumlanmamalıdır.
Örnek:number <<= 2; /* number''ı 2 bit sola kaydır.*/
number >>= 3; /* number'ı 3 bit sağa kaydır.*/
Kural 3- Yorum içerisinde /, // veya \ içermemelidir.
Kural 4- Bir kod bloğunu geçici olarak devre dışı bırakmak için, önişlemcinin koşullu derleme özelliğini kullanın.
Örnek:#if 0
Bu kod bloğu geçici olarak devre dışı bırakılmıştır.
// Kod
// ...
#endif
Kural 5- Önemli konuları vurgulamak için aşağıdaki büyük harfli yorum işaretlerini kullanın:
i. "WARNING: ", kodu okuyan kişiye bu kodu değiştirmenin risk taşıdığını bildirir.
Örnek:/*
WARNING: Bu kodu değiştirmek riskli olabilir, dikkatlice kontrol edin.
*/
ii. "NOTE: ", bir kod parçasının "neden"i hakkında açıklayıcı yorumlar sağlar.
Örnek:/*
NOTE: Bu döngü, verileri işlemek için bir kez dönüyor.
*/
iii. "TODO: ", kodun belirli bir bölgesinin hala inşa aşamasında olduğunu ve nelerin yapılması gerektiğini açıklar.
Örnek:/*
TODO: Bu kısım henüz tamamlanmadı, eksik işlemleri ekleyin.
*/