C # Yorumları: Nasıl Kullanılır ve Neden?

Bu yazıda, C # yorumları, farklı yorum stilleri ve bunların bir programda neden ve nasıl kullanılacağını öğreneceğiz.

Yorumlar, bir kod parçasını anlamamıza yardımcı olmak için bir programda kullanılır. Kodu okunabilir hale getirmeyi amaçlayan insan tarafından okunabilir kelimelerdir. Yorumlar, derleyici tarafından tamamen yok sayılır.

C # 'da 3 tür yorum vardır:

  1. Tek Satır Yorumları ( //)
  2. Çok Satırlı Yorumlar ( /* */)
  3. XML Yorumları ( ///)

Tek Satır Yorumları

Tek satırlı yorumlar çift eğik çizgiyle başlar //. Derleyici //, satırın sonuna kadar her şeyi yok sayar . Örneğin,

int a = 5 + 7; // 5 ve 7 ekleniyor

İşte Adding 5 and 7yorum.

Örnek 1: Tek satır yorumu kullanma

 // Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )

Yukarıdaki program 3 tek satır yorum içermektedir:

 // Merhaba Dünya Programı // Yürütme Ana yöntemden başlar

ve

 // Merhaba Dünya'yı yazdırır

Tek satır açıklamalar ayrı bir satıra veya aynı satırdaki kodlarla birlikte yazılabilir. Ancak yorumların ayrı bir satırda kullanılması tavsiye edilir.

Çok Satırlı Yorumlar

Çok satırlı yorumlar ile başlar /*ve ile biter */. Çok satırlı yorumlar birden çok satıra yayılabilir.

Örnek 2: Çok satırlı yorumu kullanma

 /* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )

Yukarıdaki program 2 çok satırlı açıklama içerir:

/ * Bu C # dilinde bir Merhaba Dünya Programıdır. Bu program Hello World yazdırır. * /

ve

 / * Hello World yazdırır * /

Burada, çok satırlı bir yorumun birden çok satıra yayılmasının zorunlu olmadığını fark etmiş olabiliriz. /*… */tek satır açıklamalar yerine kullanılabilir.

XML Belgeleme Yorumları

XML dokümantasyon yorumu, C #'daki özel bir özelliktir. Üçlü bölü çizgisiyle başlar ve bir ///kod parçasını kategorik olarak tanımlamak için kullanılır… Bu, bir yorum içinde XML etiketleri kullanılarak yapılır. Bu yorumlar daha sonra ayrı bir XML dokümantasyon dosyası oluşturmak için kullanılır.

XML'e aşina değilseniz, XML nedir? Konusuna bakın.

Örnek 3: XML dokümantasyon açıklamasını kullanma

 /// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )

Yukarıdaki programda kullanılan XML yorumu

/// /// Bu bir merhaba dünya programıdır. ///

Oluşturulan XML belgeleri (.xml dosyası) şunları içerecektir:

 Selam Dünya

Daha fazla bilgi edinmek istiyorsanız XML Belgeleme Yorumlarını ziyaret edin.

Yorumları Doğru Şekilde Kullanın

Yorumlar kodun bölümlerini açıklamak için kullanılır, ancak aşırı kullanılmamalıdır.

Örneğin:

 // Hello World Console.WriteLine ("Merhaba Dünya");

Yukarıdaki örnekte yorum kullanmak gerekli değildir. Hattın Hello World yazacağı açıktır. Bu tür durumlarda yorumlardan kaçınılmalıdır.

  • Bunun yerine, programda karmaşık algoritmaları ve teknikleri açıklamak için yorumlar kullanılmalıdır.
  • Yorumlar, uzun bir açıklama yerine kısa ve öz olmalıdır.
  • Genel bir kural olarak, açıklanması için daha iyidir neden yerine nasıl yorumlarını kullanma.

Ilginç makaleler...