Bir bilgisayarda programlama yaparken, bazen diğer geliştiricilerin kodunuza kolaylıkla göz atabilmesi için notlar veya yorumlar bırakmak gerekir. Açık kaynaklı bir proje veya tescilli bir proje olsun, ortak geliştiriciler ve gelecekteki olası geliştiricilerle koordinasyon sağlamak için yorumlara ihtiyaç vardır. Yorumlar olmadan, kod basitçe sürdürülemez olurdu.
adımlar
Adım 1. Bir bilgisayar programını yorumlamanın amacını anlayın
- Burada önemli olan okunabilirliktir. Bir yoruma baktığınızda, bunun bir kod satırı değil, bir yorum olduğunu bilmelisiniz.
- Yorum sadece size değil, bilgisayar programınızın kaynak kodunu okuyabilecek başka herkese de yardımcı olmalıdır.
Adım 2. Noktanızı aşmanın kısa ve basit bir yolunu düşünün
Yorumların bir sanat eseri olması gerekmez. Kısa, öz ve doğrudan konuya uygun olmalıdırlar.
Ancak bu, bir yorum için birden çok satırın kullanılmasını engellememelidir. Mesele şu ki, bilginin okuyucuya ulaşması gerekiyor
Adım 3. Programlama dili tarafından verilen uygun sözdizimini kullanarak yorumu yazın
Adım 4. Yazdığınız yorumun yeterince ayrıntılı olup olmadığını kendinize sorun
Bir yorum, kaynak koduna bakan birine, programın o bölümünün onu derlemeye ve çalıştırmaya gerek kalmadan gerçekte ne yaptığını söyleyebilmelidir. Yorumunuz bunu sağlıyor mu? Tüm detayları aktarıyor mu?