Code Comments

Kod yazarken, girdiğin neredeyse her karakterin veya kelimenin özel bir anlamı olacağı gerçeğini kısa sürede öğreneceksin. Örneğin, class, namespace, public ve benzeri gibi bir çok anahtar kelime göreceksin. Girdiğin değişkenler ve metotların doğru olup olmadığının kontrolünü yapan derleyicinin, aynı zamanda bu anahtar kelimelerini kullanıp kullanmadığını da kontrol ettiğini göreceksin. C# tam bir mutlak dildir ve derleyici, her şeyi olması gerektiği gibi yazman konusunda yardımcı olacak. Ancak, kod yorumları kavramı sayesinde istediğini yazabilmenin de bir yolu var.

C# veya başka bir dilde olsun, gördüğün bazı kodlarda belki yorumların bulunduğunu da fark etmişsindir. Yani kod yorumları girme işi oldukça evrensel ve yaygındır. Yazmanın farklı yolları var, bu yüzden C# kodun için kullanabileceğin yorum tiplerine bir bakalım.

Tek satırlık yorumlar

C# dilinde kullanılan en temel yorum satırı tipi tek satırlık yorumlardır. Adından da anlaşılabileceği gibi, tek bir satırı yorum satırına dönüştürür. Nasıl olduğuna bakalım:

// My comments about the class name could go here...
class Program
{
    ......

İşte bu kadar: Kod satırının önüne çift eğik çizgi (//) koyarsanız derleyicinin hiçbir şekilde dikkate almayacağı bir şeye dönüştürürsünüz. Bu sadece başına çift eğik çizgi koyduğunuz satır için geçerlidir. Aynısını bir sonraki satırlara da uygulayabilirsiniz. Tek satırlık yorumları kullanarak birden fazlasını yorum satırı haline şöyle getirebilirsiniz:

// My comments about the class name could go here...
// Add as many lines as you would like
// ...Seriously!
class Program
{
    ...... 

Çok satırlı yorumlar

Bazı durumlarda çok satırdan oluşan yorumlar yazmak isteyebilirsiniz. Böyle durumlarda C#'ın sunduğu çok satırlı yorum varyantını kullanmak daha mantıklı olabilir. Her satırın başına çift eğik çizgi yazmaktansa, başlangıç ve bitiş karakterinin yerlerini belirlersiniz. İkisinin arasındaki her şey yorum olarak ele alınır.

/*  
My comments about the class name could go here...  
Add as many lines of comments as you want  
    ...and use indentation, if you want to!  
*/  
class Program  
{
    ......

Başlangıç işareti olarak sağa eğik çizgi-yıldız ( /* ) kullanın, tek satır ya da satırlar boyunca istediğiniz açıklamayı, yorumu vs. yazın. Bitiş işareti olarak yıldız-sağa eğik çizgi ( */ ) kullanın. Bu iki işaret arasına yazdığınız her şey yorum olarak ele alınır.

Hemen hemen tüm diğer programlama ile ilgili konularda olduğu gibi, birden fazla tek satırlık yorum kullanmak mı tercih edilmeli yoksa direkt çok satırlı yorum kullanmak mı tercih edilmeli konusu tartışılır. Ben, duruma göre ikisini de kullanıyorum. Hangisini kullanacağın sana kalmış!

Belge açıklamaları

Belge Açıklamaları (bazen XML Belge Açıklamaları olarak da adlandırılır) normal yorumlar gibi görünür fakat farklı olarak XML ile gömülüdür. Aynı normal yorumlar gibi iki farklı formda gelirler: Tek satırlı ve çok satırlı. Aynı zamanda neredeyse aynı şekilde yazılırlar fakat, fazladan bir karakter ile. Yani, tek satırlık XML Belge Açıklamaları iki yerine üç sağa eğik çizgi (///) ile yazılırlar. Çok satırlık olanı ise başlangıç satırında fazladan yıldız içerir. Nasıl olduğunu görelim:

class User
{
    /// <summary>
    /// The Name of the User.
    /// </summary>
    public string Name { get; set; }

    /**
    * <summary>The Age of the User.</summary>
    */
    public string Age { get; set; }
}

Burada iki çeşidini de gördün; tek satırlık ve çok satırlık. Sonuç aynı fakat, tek satırlık olanı belge açıklamaları için en çok kullanılan çeşit gibi görünüyor.

Veri tiplerini ve üyelerini belge açıklamaları ile belgelemek büyük bir başlık konusu. Bu yüzden sonraki başlıklarda bu konunun daha derinine ineceğiz fakat, şimdilik nasıl göründüğünü biliyorsun!

Kod yorumları & Görev listesi

Eğer Visual Studio kullanıyorsan, kod yorumlarını takip için yardım alabilirsin. Görev listesi penceresinde (Görünüm > Görev Listesi menüsünden erişebilirsin) yorumların görünecektir:

//TODO: Change "world" to "universe"
Console.WriteLine("Hello, world!");
//HACK: Don't try this at home....
int answerToLife = 42;

Yani gördüğünüz TODO veya HACK yazan tek satırlık yorumlar Visual Studio'nun Görev Listesinde şöyle görünecektir:

Ve daha fazla çeşit var. Kullandığın Visual Studio sürümüne göre, aşağıdaki yorum belirteçlerinin bazılarına veya tümüne yanıt verecektir:

• TODO
• HACK
• NOTE
• UNDONE

Eğer istersen kendi belirteçlerini bile ekleyebilirsin. Buradaki adımları izleyin.

Özet

Kod yorumları kodlarını belgelemen için, kendine hatırlatmalar yapmak için veya bu kodu gören başkalarına kodu açıklamak için aşırı kullanışlıdırlar. Ek olarak, bir şeyi hızlıca test etmek istersen de işine yarayabilirler. Satırı kopyala ve bu satırı yorum satırına dönüştürerek kopyaladığının üzerinde değişiklik yap. Dilediğin zaman kopyaladığın satırı silebilir ve yorum satırını tekrar işlevsel hale getirip her şeyi önceki haline getirebilirsin.

Kullanıcıların bu yorumlarını görmesi konusunda da endişelenme. Önceden de belirttiğim gibi, yorum satırları derleyiciler tarafından tamamen görmezden gelinir ve böylece oluşturulan DLL veya EXE dosyası bu yorumları içermez. Kod yorumlarını kullanmak programlamadaki kişisel özgürlüğündür bu yüzden istediğin her şekilde kullanabilirsin.