C # komentari: Kako ih koristiti i zašto?

U ovom ćemo članku naučiti o C # komentarima, različitom stilu komentara i zašto i kako ih koristiti u programu.

Komentari se koriste u programu koji nam pomaže da razumijemo dio koda. To su čovjeku čitljive riječi kojima je cilj učiniti kod čitljivim. Kompajlator je komentare potpuno ignorirao.

U C # postoje 3 vrste komentara:

  1. Jednoredni komentari ( //)
  2. Višeredni komentari ( /* */)
  3. XML komentari ( ///)

Jednoredni komentari

Jednoredni komentari započinju dvostrukom kosom crtom //. Kompajler ignorira sve nakon //do kraja retka. Na primjer,

int a = 5 + 7; // Dodavanje 5 i 7

Evo, Adding 5 and 7komentar je.

Primjer 1: Upotreba jednorednog komentara

 // 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!"); ) ) )

Gornji program sadrži 3 komentara u jednom retku:

 // Program Hello World // Izvršenje započinje od glavne metode

i

 // Prints Hello World

Komentar u jednom retku može se napisati u zaseban redak ili zajedno sa kodovima u istom retku. No, preporuča se korištenje komentara u zasebnom retku.

Višeredni komentari

Višeredni komentari počinju s /*i završavaju s */. Višeredni komentari mogu se protezati u više redaka.

Primjer 2: Korištenje višerednog komentara

 /* 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!"); ) ) )

Gornji program sadrži 2 višeredna komentara:

/ * Ovo je program Hello World na C #. Ovaj program ispisuje Hello World. * /

i

 / * Otisci Hello World * /

Ovdje smo možda primijetili da komentar s više redaka nije obvezan obuhvaćati više redaka. /*… */može se koristiti umjesto jednostrukih komentara.

Komentari XML dokumentacije

Komentar XML dokumentacije posebna je značajka u C #. Počinje s trostrukom kosom crtom ///i koristi se za kategorički opis dijela koda … To se radi pomoću XML oznaka u komentaru. Ti se komentari zatim koriste za stvaranje zasebne datoteke XML dokumentacije.

Ako niste upoznati s XML-om, pogledajte Što je XML?

Primjer 3: Korištenje komentara o XML dokumentaciji

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

XML komentar korišten u gornjem programu je

/// /// Ovo je zdravo svjetski program. ///

Generirana XML dokumentacija (.xml datoteka) sadržavat će:

 Pozdrav svijete

Posjetite komentare XML dokumentacije ako vas zanima više.

Koristite komentare na pravi način

Komentari se koriste za objašnjavanje dijelova koda, ali ih se ne smije pretjerivati.

Na primjer:

 // Ispisuje Hello World Console.WriteLine ("Hello World");

Upotreba komentara u gornjem primjeru nije potrebna. Očito je da će se na liniji ispisati Hello World. U takvim slučajevima treba izbjegavati komentare.

  • Umjesto toga u programu se trebaju koristiti komentari za objašnjavanje složenih algoritama i tehnika.
  • Komentari bi trebali biti kratki i precizni, umjesto dugog opisa.
  • U pravilu je bolje objasniti zašto, umjesto kako , koristeći komentare.

Zanimljivi članci...