C# - Yorum Yazma

Programlama dillerinde yorum yazmak özellikle belli bir düzeydeki uygulamalarda çok önemlidir. Kodun ne anlama geldiği veya kodun kim tarafından ne zaman yazıldığı, düzeltildiği gibi konularda çok işe yarar.

C#'ta yorum yazmak başka birçok programlama dili ile aynıdır.

Tek Satırla Yorum Yazmak

C# 'daki en temel yorum türü tek satırda yazılmış yorumlardır. Adından da anlaşılacağı gibi, tek bir satırı bir yoruma çevirir.

Aşağıdaki örnekte tek satırlı bir yorum örneğini görmektesiniz..

 // Yorum satırım
    class Program
    {
        static void Main(string[] args)
        {           
        }
    }

Satırlarınıza "//" (iki slash) ekleyerek içine yazılacak metniniz, compiler'ın (derleyici) kontrol edeceği durumdan çıkar. Derleyicinin tamamen göz ardı ettiği bir şeye dönüşür. Bir sonraki satır veya satırlarda da aynısını yapablirsiniz.

Aşağıdaki örnekte bunu gösterelim..


    // Yorum 1
    // Yorum 2
    // Yorum 3
    class Program
    {
        static void Main(string[] args)
        {           
        }
    }

Birden Çok Satırlı Yorum Yazmak

Birden fazla yorum satırı yazmak isterseniz, C#'ın sunduğu çok satırlı yorum işaretlerini kullanmak daha mantıklı olacaktır. Her satıra "//" eklemek yerine, sadece bir başlangıç ve bitiş karakter dizisi girersiniz arasındaki her şey yorum metni olarak değerlendirilir.

Aşağıda birden çok satırlı bir yorum metni örneği gösterilmektedir..

/*  
Yorum 1
Yorum 2
Yorum 3
*/ 
class Program
{
}

Örnekte de gösterildiği üzere slash ve yıldız karakterleri "/*" başlangıç sırasını belirtir, istediğiniz her şeyi birden çok satıra yazarak yorum metni girebilirsiniz. İsterseniz tek satırda da bunu kullanabilirsiniz. "*/" ile çok satırlı yorum yazmayı bitirirsiniz.

Dökümanlar İçin Yorum Yazmak

Dokümantasyon Yorumları normal yorumlar gibi görünür. Düzenli yorumlarda olduğu gibi, tek satırlı ve çok satırlı olarak iki şekilde yaratılır. Burada da mantık aynıdır. Fakat ekstradan bir karakter fazla konur. Tek satır için 2 slash yerine 3 slash (///) kullanılır. Çoklu satır için ise başlangıca ek olarak bir yıldız daha konur. (/**)

Aşağıda her ikisine de bir örnek verilmiştir..

class User
{
    /// < summary>
    /// Kişinin adı
    /// < / summary>
    public string Ad { get; set; }
    /**
    * < summary> Kişinin bağlı şehiri < / summary>
    */
    public string Sehir { get; set; }
}

Her iki örnekte aynı şeyi ifade etmektedir. Dökümantasyon yorumları çok önemlidir. Bir fonksiyon veya başka bir üye çağırıldığında onun ne işe yaradığı anlatmak açısından çok işimize yarar.

Örneğin bir proje üzerinde 5 kişi çalışıyor. Her bir modülü farklı kişiler yazmakta. Bir kişinin yazdığı bir fonksiyonu başka bir kişi kullanacak. Fonksiyonu kullanacak kişi onun ne işe yaradığı veya nasıl kullanılacağını yazan kişiye sormak yerine dökümantasyon yorumunu okuyarak işini halledebilir. Bu yorumlar siz fonksiyonu çağırdığınızda (invoke) derleyicide otomatik olarak çıkacaktır.



İlginizi Çekebilir

C# - Aşırı Yükleme (Overload)

C# - If Else İfadesi

C# - Static İfadesi

C# - Switch Case İfadesi

C# - Görünürlük