Programlama dillerinde en sık kullanılan üç şey nedir diye sorsalar çıktı almak, toplam almak ve yorum eklemek derdim. Yorumlar, yazılımcıya aşağıdaki gibi çeşitli konforlar katmaktadırlar:
- Kod satırları arasında tüm satırı ya da satırın biir kısmını işlevsiz hale getirebilme ya da kodun çalışır/işlevsiz olması arasında switch etme olanağı
- Kodların ne amaçla yazıldıkları ya da nasıl bir algoritma ile çalıştıkları konusunda hatırlatmalar ekleme
- Kendinden başka yazılımcılara (özellikle açık kaynaklı kod geliştirme çalışmalarında) notlar bırakma
- Sonraki zamanlarda yapılacak görevlerle ilgili işler bırakma (farklı önem derecelerinde TODO task'ları)
Programlama dillerinde yorum nedir sorusuna yanıt vermek gerekirse de program derleyicisi tarafından dikkate alınmayan tüm yazılara ve kodlara yorum (comment) denir. Böylece normalde hata verecek düz yazılar ya da açıp kapatılması gereken program kodları yorum olarak özgürce yazılabilirler.
Özellikle yazılan kodların zaman zaman yıllar sonra tekrar okunarak revize edilmesi gereken zamanlarda "ben bunu niye yapmışım" ya da "acaba burada ne düşünmüşüm" gibi soruların yanıtlarının yazılımcı tarfından gelecekteki kendine veriliyor olması çok hoş bir uygulama.
Python'da yorum satırı olarak # (diyez karakteri) karakteri kullanılır ve # karakterinden sonra gelen yazılar/kodlar derleyici tarafından dikkate alınmazlar. Daha önce farklı yazarlar tarafından farklı dillerde yazılmış yorum kullanım yazılarını da derleyerek paylaşmak istedim.
Java'da Yorum Yazımı
Javascript'te Yorum Yazımı
Android Studio'da Yorum Yazımı
Yorum kullanımına örnekler vererek konunun pekişmesini sağlayalım:
Örnek 1: Kodunuza, yazdığınız satırların ne amaçla hazırlandığını açıklayan yorumlar ekleyin.
print(3+5) #burada sayıların toplamını hesapladım
Örnek 2: Kodunuza, gelecekte bu kodu okursanız ne yapmanız gerektiğini anlatan tam satır not ekleyin.
#kullanıcıya merhaba demeden işlem yapma
print("merhaba")
Örnek 3: Kodunuza, matematiksel bir işlemin sonucunu gösteren bir yorum ekleyin
print(7+8) #15
Örnek 4: Bir kod satırını işlevsiz hale getiren bir yorum satırı ekleyin
#print(2+2)