Představení jazyka C#

Zdrojový je vhodné udržovat ve formě, která je přehledná, čitelná, vhodně rozdělená, popsaná atd. Pro tyto účely můžeme využít následující prvky, které nemají vliv na provádění zdrojového kódu programu.

Komentář

Komentář (anglicky „Comment“) je dodatečná informace (popisující např. podstatu kódu), který nemá vliv na chod přeloženého programu. Komentář často uživateli pomůže rychle pochopit již dříve vytvořený algoritmus, ke kterému se po čase vrátil. Komentář může také sloužit jako informace ostatním osobám, který budou daný kód analyzovat, a může jim pomoci se rychleji orientovat v daném algoritmu zapsaném ve formě kódu.

Asi jste si všimli ve zdrojovém kódu zeleného textu, který je uvozen dvojitým lomítkem // - viz Kód 1.

//Deklarace proměnné
string osloveni;

Kód 1: Komentář k deklaraci proměnné - program HelloWorldPromenna

Tato dvě lomítka umístěná za sebou značí jednořádkový komentář. Díky okomentování tohoto příkazu některé z příkazu ve zdrojovém kódu, nebude tento příkaz v programu vykonán.

Pro úplnost si ještě uveďme značku komentáře používanou v předchozích algoritmech zaznamenaných pomocí vývojových diagramech – viz Obrázek 1.

Obrázek 1: Komentář k deklaraci proměnné - algoritmus HelloWorld_Promenna

Pokud programátor potřebuje víceřádkový komentář, použije lomítko s hvězdičkou pro počátek komentáře /* a víceřádkový komentář uzavře pomocí hvězdičky a lomítka, tj. */ .

Poznámky k dokumentaci ve formě XML

V C# můžeme také vytvořit dokumentaci, kterou lze uvádět u třídy, metody, atributu atd. Poznámky jsou speciální typ dokumentace pomocí XML prvků přidaného ke zdrojovému kódu. Tyto XML prvky jsou uvozeny pomocí trojitého lomítka ///. Taková poznámka specifikovaná např. u metody, bude zobrazena, pokud najedete kurzorem na jméno metody, kterou voláte.

/// <summary>
/// Dokumentace k metodě
/// </summary>

Kód 2: Dokumentace k metodě

/// <returns>Výstup metody</returns>

Kód 3: Dokumentace k výstupu

/// <param name="param1">Komentář k parametru1</param>

Kód 4: Dokumentace k parametru

Oblasti v kódu

U kódu lze také využít poznámky pro rozdělení kódu do jednotlivých oblastí, které kód zpřehledňují, udržují více organizovaný atd. - viz Kód 5. Tyto oblasti je možné sbalit anebo rozbalit. U oblastí lze také využít princip vnoření, tzn., že do oblasti lze umístit další oblasti.

#region Poznámka k oblasti
//…
#endregion

Kód 5: Oblast v kódu