C # komentarai: Kaip juos naudoti ir kodėl?

Šiame straipsnyje sužinosime apie C # komentarus, skirtingą komentarų stilių ir kodėl bei kaip juos naudoti programoje.

Komentarai naudojami programoje, kad padėtų mums suprasti kodo dalį. Tai yra žmonėms skaitomi žodžiai, skirti padaryti kodą įskaitomą. Kompiliatorius visiškai ignoruoja komentarus.

C # yra 3 tipų komentarai:

  1. Vienos eilutės komentarai ( //)
  2. Kelių eilučių komentarai ( /* */)
  3. XML komentarai ( ///)

Vienos eilutės komentarai

Vienos eilutės komentarai prasideda dvigubu pasviruoju brūkšniu //. Kompiliatorius nepaiso visko po //eilutės pabaigos. Pavyzdžiui,

int a = 5 + 7; // Pridedami 5 ir 7

Čia Adding 5 and 7yra komentaras.

1 pavyzdys: vienos eilutės komentaro naudojimas

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

Pirmiau pateiktoje programoje yra 3 vienos eilutės komentarai:

 // „Hello World“ programa // Vykdymas prasideda nuo pagrindinio metodo

ir

 // Spausdina Sveikas pasaulis

Vienos eilutės komentarai gali būti rašomi atskiroje eilutėje arba kartu su kodais toje pačioje eilutėje. Tačiau rekomenduojama komentarus naudoti atskiroje eilutėje.

Kelių eilučių komentarai

Kelių eilučių komentarai prasideda /*ir baigiasi */. Kelių eilučių komentarai gali apimti kelias eilutes.

2 pavyzdys: kelių eilučių komentaro naudojimas

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

Pirmiau pateiktoje programoje yra 2 kelių eilučių komentarai:

/ * Tai „Hello World“ programa C # kalba. Ši programa spausdina „Hello World“. * /

ir

 / * Spausdina Hello World * /

Galbūt pastebėjome, kad kelių eilučių komentaras nėra privalomas. /*… */galima naudoti vietoj vienos eilutės komentarų.

XML dokumentacijos komentarai

XML dokumentacijos komentaras yra ypatinga C # funkcija. Jis prasideda trigubu pasviruoju brūkšniu ///ir yra naudojamas kategoriškai apibūdinti kodo dalį … Tai daroma naudojant XML žymas komentare. Šie komentarai naudojami kuriant atskirą XML dokumentacijos failą.

Jei nesate susipažinę su XML, žr. Kas yra XML?

3 pavyzdys: XML dokumentacijos komentaro naudojimas

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

Ankstesnėje programoje naudojamas XML komentaras yra

/// /// Tai „labo pasaulio“ programa. ///

Sukurtoje XML dokumentacijoje (.xml faile) bus:

 Labas pasauli

Apsilankykite XML dokumentacijos komentaruose, jei norite sužinoti daugiau.

Naudokite komentarus teisingu keliu

Komentarai naudojami paaiškinant kodo dalis, tačiau jų nereikėtų per daug naudoti.

Pavyzdžiui:

 // Spausdina „Hello World Console.WriteLine“ („Sveikas pasaulis“);

Ankstesniame pavyzdyje komentaro naudoti nereikia. Akivaizdu, kad linija atspausdins „Hello World“. Tokiais atvejais reikėtų vengti komentarų.

  • Vietoj to, norint paaiškinti sudėtingus algoritmus ir metodus, programoje turėtų būti naudojami komentarai.
  • Komentarai turėtų būti trumpi ir tikslūs, o ne ilgas aprašymas.
  • Kaip taisyklė, geriau paaiškinti kodėl, o ne kaip , naudodamas komentarus.

Įdomios straipsniai...