V tomto článku se dozvíme o C # komentářích, odlišném stylu komentářů a proč a jak je používat v programu.
Komentáře se používají v programu, který nám pomáhá porozumět části kódu. Jsou to slova čitelná člověkem, jejichž cílem je zajistit čitelnost kódu. Kompilátor komentáře zcela ignoruje.
V C # existují 3 typy komentářů:
- Jednořádkové komentáře (
//) - Víceřádkové komentáře (
/* */) - Komentáře XML (
///)
Jednořádkové komentáře
Jednořádkové komentáře začínají dvojitým lomítkem //. Kompilátor ignoruje vše po //konec řádku. Například,
int a = 5 + 7; // Přidání 5 a 7
Tady Adding 5 and 7je komentář.
Příklad 1: Použití komentáře s jedním řádkem
// 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!"); ) ) )
Výše uvedený program obsahuje 3 jednořádkové komentáře:
// Program Hello World // Provádění začíná od hlavní metody
a
// Vytiskne Hello World
Jednořádkové komentáře lze psát do samostatného řádku nebo spolu s kódy ve stejném řádku. Doporučuje se však použít komentáře v samostatném řádku.
Víceřádkové komentáře
Víceřádkové komentáře začínají /*a končí */. Víceřádkové komentáře mohou zahrnovat více řádků.
Příklad 2: Použití víceřádkového komentáře
/* 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!"); ) ) )
Výše uvedený program obsahuje 2 víceřádkové komentáře:
/ * Toto je program Hello World v C #. Tento program vytiskne Hello World. * /
a
/ * Vytiskne Hello World * /
Zde jsme si možná všimli, že není povinné, aby se víceřádkový komentář rozšířil na více řádků. /*… */lze použít místo komentářů v jednom řádku.
Komentáře k dokumentaci XML
Komentář k dokumentaci XML je speciální funkce v C #. Začíná trojitým lomítkem ///a slouží k kategorickému popisu části kódu… Děje se to pomocí značek XML v komentáři. Tyto komentáře se poté použijí k vytvoření samostatného souboru dokumentace XML.
Pokud nejste obeznámeni s XML, podívejte se na Co je XML?
Příklad 3: Použití komentáře k dokumentaci XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Komentář XML použitý ve výše uvedeném programu je
/// /// Toto je ahoj světový program. ///
Vygenerovaná dokumentace XML (soubor .xml) bude obsahovat:
Ahoj světe
Pokud se chcete dozvědět více, navštivte komentáře k dokumentaci XML.
Používejte komentáře správným způsobem
Komentáře se používají k vysvětlení částí kódu, ale neměly by se nadměrně používat.
Například:
// Vytiskne Hello World Console.WriteLine ("Hello World");
Použití komentáře ve výše uvedeném příkladu není nutné. Je zřejmé, že řádek vytiskne Hello World. V takových případech je třeba se vyhnout komentářům.
- Místo toho by v programu měly být použity komentáře k vysvětlení složitých algoritmů a technik.
- Komentáře by měly být krátké a věcné, namísto dlouhého popisu.
- Zpravidla je lepší vysvětlit proč, místo toho, jak , pomocí komentářů.
