C # komentarji: Kako jih uporabljati in zakaj?

V tem članku bomo spoznali komentarje C #, različen slog komentarjev ter zakaj in kako jih uporabiti v programu.

Komentarji se uporabljajo v programu za lažje razumevanje dela kode. So človekom berljive besede, katerih namen je narediti kodo berljivo. Kompajler prevajalnik komentarje popolnoma prezre.

V C # obstajajo 3 vrste komentarjev:

  1. Enovrstični komentarji ( //)
  2. Komentarji z več vrsticami ( /* */)
  3. Komentarji XML ( ///)

Enovrstični komentarji

Enovrstični komentarji se začnejo z dvojno poševnico //. Prevajalnik ignorira vse //do konca vrstice. Na primer

int a = 5 + 7; // Dodajanje 5 in 7

Tukaj Adding 5 and 7je komentar.

Primer 1: Uporaba enovrstnega komentarja

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

Zgornji program vsebuje 3 enovrstne komentarje:

 // Program Hello World // Izvedba se začne od glavne metode

in

 // Natisne Hello World

Enovrstne komentarje lahko napišete v ločeno vrstico ali skupaj s kodami v isti vrstici. Priporočljivo pa je, da komentarje uporabite v ločeni vrstici.

Komentarji z več vrsticami

Komentarji z več vrsticami se začnejo z /*in končajo z */. Komentarji z več vrsticami lahko obsegajo več vrstic.

2. primer: Uporaba večvrstičnega komentarja

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

Zgornji program vsebuje 2 večvrstična komentarja:

/ * To je program Hello World v jeziku C #. Ta program natisne Hello World. * /

in

 / * Natisne Hello World * /

Tu smo morda opazili, da komentar z več vrsticami ni obvezen, da sega v več vrstic. /*… */se lahko uporablja namesto enovrstnih komentarjev.

Pripombe k dokumentaciji XML

Komentar dokumentacije XML je posebnost C #. Začne se s trojno poševnico ///in se uporablja za kategoričen opis kosa … To se naredi z uporabo oznak XML v komentarju. Ti komentarji se nato uporabijo za ustvarjanje ločene dokumentacijske datoteke XML.

Če XML ne poznate, glejte Kaj je XML?

Primer 3: Uporaba komentarja dokumentacije XML

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

Komentar XML, uporabljen v zgornjem programu, je

/// /// To je program zdravega sveta. ///

Ustvarjena dokumentacija XML (datoteka .xml) bo vsebovala:

 Pozdravljen, svet

Obiščite komentarje dokumentacije XML, če vas zanima več.

Uporabite komentarje na pravi način

Komentarji se uporabljajo za razlago delov kode, vendar jih ne smemo pretiravati.

Na primer:

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

Uporaba komentarja v zgornjem primeru ni potrebna. Očitno je, da bo vrstica natisnila Hello World. V takšnih primerih se je treba izogibati komentarjem.

  • Namesto tega je treba v programu uporabiti komentarje za razlago zapletenih algoritmov in tehnik.
  • Komentarji naj bodo kratki in natančni namesto dolgega opisa.
  • Kot pravilo je bolje, da s komentarji razložite, zakaj in ne kako .

Zanimive Članki...