Yorum satırı ne işe yarar?

Yorum satırı ne işe yarar? www.yzokul.com.tr

Yorum satırı, insanların okuması için kodun içine yazılmış bir nottur. Bir açıklama ya da ek bilgi sunar. Normalde bir komut olarak çalıştırılmaz, bu yüzden program çalışırken bilgisayar onu atlar. Onu, yazarın kodu daha sonra okuyacak herkese bıraktığı bir mesaj olarak düşün. Temel görevi, insanların kodu daha iyi anlamasına yardımcı olmaktır. 1

Kod, bilgisayarın yürütmesi için yazılır ama daha sonra insanlar tarafından da okunur. Bu kişiler başka programcılar, hatta gelecekteki sen olabilirsin. Yorumlar, bu okuyucuların kodun kendisinde bulunmayan ek açıklamayı aldığı yerdir. Yorumlar olmadan okuyucular anlamı tahmin etmek zorunda kalır. Yorumlar kodu herkes için daha anlaşılır kılar. 2

Bir yorumu, kodun içine yapıştırılmış bir not gibi, sayfadaki bir yapışkan not gibi düşün. Kodun yanında durur ama makineye değil, insanlara seslenir. Bilgisayar onu yok sayar, ama insanlar okuyabilir. Bir yorumu kendi satırına ya da bir kod satırının sonuna yazabilirsin. Bağlam ve açıklık sağlamak için oradadır. 3

Program çalıştığında yorum normalde atlanır. Bilgisayar onu bir şey yapma talimatı olarak görmez. Programın harekete geçmesini sağlayan bir komut değildir. Bunun yerine, bilgisayarın üzerinden geçtiği bir metindir yalnızca. Bu, programın çalışma biçimini değiştirmeden yorumları serbestçe yazabileceğin anlamına gelir. Yalnızca insan okuyucular içindirler. 4

Bir yorum, kodda bir kararın neden alındığını açıklayabilir. Bir seçimin arkasındaki neden genellikle yazılabilecek en yararlı şeydir. Örneğin, daha hızlı ya da daha güvenli olduğu için belirli bir yöntemi seçebilirsin. Bir yorum bu nedeni kaydedebilir, böylece başkaları da anlar. Bu olmadan biri bunu neden bu şekilde yaptığını merak edebilir. 5

Bir yorum karmaşık bir işlemin amacını da tanımlayabilir. Kodun bir bölümü zor olduğunda, bir yorum okuyucunun neyin amaçlandığını kavramasına yardımcı olur. Amacı basit sözcüklerle özetleyebilir. Bu, özellikle kodun kendisi uzun ya da takip etmesi zorsa yararlıdır. Yorum, büyük resmi verir. 6

Bir yorumun belirli bir sınırın neden kullanıldığını açıkladığı basit bir örneği ele al. En fazla 100 öğe belirlediğini varsayalım. Bir yorum, bu sınırın bellek kısıtlarına dayandığını söyleyebilir. Yorum, okuyucuya sayının arkasındaki nedeni anlatır. Bu olmadan sayı keyfi görünebilir. Yorum, seçimi açık hale getirir. 7

Kodun zaten açıkça söylediğini tekrarlamak her zaman yararlı değildir. Yalnızca apaçık olanı yeniden söyleyen bir yorum çok az değer katar. Örneğin, sayaç değerini açıkça artıran bir satırın üstüne sayacı artır diyen bir yorum yazmak gereksizdir. İyi yorumlar, kodu okumaktan zaten apaçık olmayan bilgilere odaklanır. Yeni bir kavrayış katarlar. 8

İyi yorumlar, anlaşılması kolay olmayan nedenleri ve varsayımları açıklar. Bunlar, okuyucunun yalnızca koddan göremediği şeylerdir. Örneğin, belirli bir girdinin her zaman pozitif olduğunu varsayabilirsin. Bir yorum bu varsayımı belirtebilir. Ya da belirli bir algoritmayı kullanmak için bir nedenin olabilir. Yorumlar bu gizli bilgiyi yakalar. 9

Bazı bilgiler yalnızca yazarın kafasında yaşar. Yorumlar bu gizli bilgiyi bir sonraki kişiye aktarır. Kod yazarken yazıya dökülmeyen birçok karar verirsin. Daha sonra başka biri kodu okuyup nedenini merak edebilir. Bir yorum düşüncelerini paylaşabilir ve karışıklığı önleyebilir. Yazar ile okuyucu arasındaki boşluğu doldurur. 10

Bir yorum ile bir komut farklıdır. Bir komut programı harekete geçirir, örneğin bir mesaj yazdırır ya da bir değer hesaplar. Bir yorum yalnızca açıklar; herhangi bir eyleme yol açmaz. Bilgisayar komutları çalıştırır ama yorumları atlar. Yani kod yazarken bir şeyler yapmak için komutları, açıklamak için yorumları kullanırsın. İkisi de farklı nedenlerle önemlidir. 11

Yaygın bir hata, yalnızca kodu tekrarlayan yorumlar yazmaktır. Örneğin, x = 5 satırının üstüne x'i 5 yap diyen bir yorum yararlı değildir. Çözüm, bunun yerine nedenlere ve varsayımlara odaklanmaktır. Kendine bir şeyi neden yaptığını ve hangi varsayımlarda bulunduğunu sor. Sonra bunu yoruma yaz. Bu, yorumu değerli kılar. 12

Ters hata ise zor bir kararı hiçbir açıklama olmadan bırakmaktır. Karmaşık kodu hiç yorum olmadan yazarsan, bir sonraki okuyucu anlamakta zorlanabilir. Neden hakkında kısa bir not yardımcı olur. Örneğin, bir sorunu çözmek için alışılmadık bir yaklaşım kullanıyorsan, neden onu seçtiğini açıkla. Bu, başkaları için zaman kazandırır ve hayal kırıklığını azaltır. 13

Artık kodla uyuşmayan bir yorum insanları yanıltabilir. Kodu değiştirip yorumu güncellemeyi unutursan, yanlış bilgi verebilir. Bu, hiç yorum olmamasından daha kötüdür çünkü yanlış anlamalara yol açabilir. Yorumlar dürüst ve güncel tutulmalıdır. Kodu her değiştirdiğinde, yakındaki yorumların hâlâ doğru olduğunu kontrol et. 14

Yorumlar başkalarına ve aynı zamanda kendi gelecekteki benliğine yardımcı olur. Aylar sonra koda döndüğünde bir şeyi neden yaptığını unutabilirsin. Açık bir yorum sana hatırlatır. Kodunu okuyan başkaları da açıklamalarından yararlanır. Kodu daha sonra okuyan herkes açık bir açıklamadan kazanç sağlar. Yani yorum yazmak herkes için iyi bir alışkanlıktır. 15

Özetle, bir yorum satırı insanlara bir şeyler açıklar ve normalde çalıştırılmaz. İyi yorumlar, görülmesi zor olan nedenleri ve varsayımları verir. Okuyucuların kararların neden alındığını ve karmaşık işlemlerin ne yaptığını anlamasına yardımcı olurlar. Apaçık olanı tekrarlamaktan kaçın ve yorumları doğru tut. Bilgini paylaşmak ve kodu daha anlaşılır kılmak için yorumları kullan. 16