C # Kommentaarid: kuidas neid kasutada ja miks?

Sellest artiklist saame teada C # kommentaaride, kommentaaride erineva stiili ning miks ja kuidas neid programmis kasutada.

Kommentaare kasutatakse programmis, et aidata meil koodijuppi mõista. Need on inimloetavad sõnad, mille eesmärk on muuta kood loetavaks. Koostaja ignoreerib kommentaare täielikult.

C #-s on kolme tüüpi kommentaare:

  1. Ühe rea kommentaarid ( //)
  2. Mitmerealised kommentaarid ( /* */)
  3. XML-i kommentaarid ( ///)

Ühe rea kommentaarid

Ühe rea kommentaarid algavad topeltkriipsuga //. Koostaja ignoreerib kõike pärast //rea lõppu. Näiteks,

int a = 5 + 7; 5 ja 7 lisamine

Siin Adding 5 and 7on kommentaar.

Näide 1: Üherealise kommentaari kasutamine

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

Ülaltoodud programm sisaldab 3 ühe rea kommentaari:

 // Tere maailma programm // Käivitus algab meetodist Main

ja

 // Prindib tere maailma

Ühe rea kommentaare saab kirjutada eraldi real või koos sama rea ​​koodidega. Siiski on soovitatav kasutada kommentaare eraldi real.

Mitmerealised kommentaarid

Mitmerealised kommentaarid algavad /*ja lõpevad */. Mitmerealised kommentaarid võivad ulatuda mitme rea vahele.

Näide 2: Mitmerealise kommentaari kasutamine

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

Ülaltoodud programm sisaldab 2 mitmerealist kommentaari:

/ * See on Hello Worldi programm C # keeles. See programm prindib tere maailma. * /

ja

 / * Prindib tere maailma * /

Siin oleme võib-olla märganud, et mitme reaga kommenteerimine ei ole kohustuslik mitme rea peal. /*… */saab kasutada ühe rea kommentaaride asemel.

XML-i dokumentatsiooni kommentaarid

XML-i dokumentatsiooni kommentaar on C # eripära. See algab kolmekordse kaldkriipsuga ///ja seda kasutatakse kooditüki kategooriliseks kirjeldamiseks … Selleks kasutatakse XML-silte kommentaaris. Neid kommentaare kasutatakse seejärel eraldi XML-dokumentatsioonifaili loomiseks.

Kui te pole XML-iga tuttav, vaadake jaotist Mis on XML?

Näide 3: XML-i dokumentatsiooni kommentaari kasutamine

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

Ülaltoodud programmis kasutatud XML-i kommentaar on

/// /// See on tere maailmaprogramm. ///

Loodud XML-dokumentatsioon (.xml-fail) sisaldab järgmist:

 Tere, Maailm

Kui soovite rohkem teada saada, külastage XML-i dokumentatsioonikommentaare.

Kasutage kommentaare õigesti

Kommentaare kasutatakse koodi osade selgitamiseks, kuid neid ei tohiks üle kasutada.

Näiteks:

 // Prindib Tere maailmakonsooli.WriteLine ("Tere maailm");

Kommentaari kasutamine ülaltoodud näites pole vajalik. On ilmne, et rida trükib Hello Worldi. Sellistel juhtudel tuleks kommentaare vältida.

  • Selle asemel tuleks programmis kasutada kommentaare keerukate algoritmide ja tehnikate selgitamiseks.
  • Kommentaarid peaksid olema lühikesed ja täpse, mitte pika kirjelduse.
  • Rusikareeglina on kommentaaride abil parem selgitada, miks, selle asemel, kuidas .

Huvitavad Artiklid...