Komentáře v kódu (Visual Basic)

Při prohlížení ukázek kódu můžete často narazit na symbol komentáře (').Tento symbol kompilátoru sady Visual Basic přikazuje, aby ignoroval text (neboli komentář), který za ním následuje.Komentáře jsou stručné vysvětlivky doplněné do kódu kvůli lepší orientaci těch, kteří si ho prohlížejí.

Při programování je dobrým zvykem začínat všechny procedury stručným komentářem, který popisuje funkční charakteristiky procedury (co dělá).Budete z toho mít prospěch jak vy, tak všichni ostatní, kteří tento kód prověřují.Podrobnosti implementace (jak to procedura dělá) byste měli oddělit od komentářů, které popisují funkční charakteristiky.Pokud do popisu zahrnete podrobnosti implementace, při úpravě funkce je nezapomeňte aktualizovat.

Komentáře mohou následovat za příkazem na stejném řádku, nebo obsazovat celý řádek.Obě varianty jsou znázorněny v následujícím kódu.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

Pokud komentář vyžaduje více než jeden řádek, použijte symbol komentáře na každém řádku, jak ukazuje následující příklad.

' This comment is too long to fit on a single line, so we break  
' it into two lines. Some comments might need three or more lines.

Pokyny ke komentování

Následující tabulka obsahuje obecné pokyny k tomu, jaké typy komentářů mohou být před kódem.Jsou to pouze návrhy; Visual Basic nevynucuje pravidla pro přidávání komentářů.Napište všechno, co má význam pro vás i pro kohokoli jiného, kdo si váš kód bude prohlížet.

Typ komentáře	Popis komentáře
Účel	Popisuje, co procedura dělá (ne jak to dělá).
Předpoklady	Uvádí všechny externí proměnné, ovládací prvky, otevřené soubory nebo jiné prvky, ke kterým procedura přistupuje.
Účinek	Uvádí všechny ovlivněné externí proměnné, ovládací prvky nebo soubory a účinek, který má (pouze pokud to není zřejmé).
Vstupy	Určuje účel argumentu.
Vrací	Vysvětluje hodnoty vrácené procedurou.

Mějte na paměti následující body:

• Každou deklaraci důležité proměnné by měl předcházet komentář popisující použití této deklarované proměnné.

• Proměnné, ovládací prvky a procedury by měly být pojmenovány dostatečně výstižně, aby byly komentáře zapotřebí pouze pro složité podrobnosti implementace.

• Komentáře nemohou následovat za posloupností pokračování řádku na stejném řádku.

Symboly komentáře můžete v bloku kódu přidat nebo odebrat tak, že vyberete jeden nebo více řádků kódu a kliknete na tlačítko Komentář () nebo Zrušit komentář () na panelu nástrojů Úpravy.

[!POZNÁMKA]

Komentáře můžete do kódu přidat také tak, že text uvodíte klíčovým slovem REM.Symbol ' a tlačítka Komentář/Zrušit komentář se však snadněji používají a vyžadují méně místa a paměti.

Viz také

Úkoly

Postupy: Vytvoření dokumentace XML v jazyce Visual Basic

Referenční dokumentace

Doporučené značky XML pro dokumentační komentáře (Visual Basic)

REM – příkaz (Visual Basic)

Další zdroje

Dokumentování kódu pomocí komentářů XML

Struktura programu a pravidla týkající se kódu (Visual Basic)