Poznámky C #: Ako ich používať a prečo?

V tomto článku sa dozvieme o C # komentároch, odlišnom štýle komentárov a o tom, prečo a ako ich používať v programe.

Komentáre sa používajú v programe, ktorý nám pomáha porozumieť časti kódu. Sú to slová čitateľné človekom, ktoré majú umožniť čitateľnosť kódu. Kompilátor komentáre úplne ignoruje.

V jazyku C # existujú 3 typy komentárov:

  1. Jednoriadkové komentáre ( //)
  2. Viacriadkové komentáre ( /* */)
  3. Komentáre XML ( ///)

Jednoriadkové komentáre

Komentáre s jedným riadkom sa začínajú dvojitým lomítkom //. Kompilátor ignoruje všetko po //koniec riadku. Napríklad,

int a = 5 + 7; // Sčítanie 5 a 7

Tu Adding 5 and 7je komentár.

Príklad 1: Použitie komentára s jedným riadkom

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

Vyššie uvedený program obsahuje 3 komentáre v jednom riadku:

 // Program Hello World // Vykonávanie sa začína od hlavnej metódy

a

 // Vytlačí Hello World

Komentáre k jednému riadku je možné písať do samostatného riadku alebo spolu s kódmi do rovnakého riadku. Odporúča sa však použiť komentáre v samostatnom riadku.

Viacriadkové komentáre

Viacriadkové komentáre sa začínajú /*a končia */. Viacriadkové komentáre sa môžu rozprestierať na viacerých riadkoch.

Príklad 2: Použitie viacriadkového komentára

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

Vyššie uvedený program obsahuje 2 viacriadkové komentáre:

/ * Toto je program Hello World v jazyku C #. Tento program tlačí Hello World. * /

a

 / * Vytlačí Hello World * /

Tu sme si mohli všimnúť, že nie je povinné, aby sa viacriadkový komentár rozšíril na viac riadkov. /*… */možno použiť namiesto jednoriadkových komentárov.

Komentáre k dokumentácii XML

Komentár k dokumentácii XML je špeciálna funkcia v C #. Začína sa trojitým lomítkom ///a používa sa na kategorický popis kódu … To sa deje pomocou značiek XML v komentári. Tieto komentáre sa potom použijú na vytvorenie samostatného súboru dokumentácie XML.

Ak nie ste oboznámení s XML, pozrite si Čo je XML?

Príklad 3: Použitie komentára k dokumentácii XML

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

Komentár XML použitý vo vyššie uvedenom programe je

/// /// Toto je ahoj svetový program. ///

Vygenerovaná dokumentácia XML (súbor .xml) bude obsahovať:

 HelloWorld

Ak sa chcete dozvedieť viac, navštívte Komentáre k dokumentácii XML.

Používajte Komentáre správnym spôsobom

Komentáre sa používajú na vysvetlenie častí kódu, nemali by sa však nadmerne používať.

Napríklad:

 // Vypíše Hello World Console.WriteLine ("Hello World");

Použitie komentára vo vyššie uvedenom príklade nie je potrebné. Je zrejmé, že na riadku bude vytlačený Hello World. V takýchto prípadoch je potrebné sa vyhnúť komentárom.

  • Namiesto toho by sa v programe mali používať komentáre na vysvetlenie zložitých algoritmov a techník.
  • Komentáre by mali byť krátke a vecné, namiesto dlhého popisu.
  • Ako pravidlo je lepšie vysvetliť, prečo namiesto toho , pomocou komentárov.

Zaujímavé články...