Sdílet prostřednictvím

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

Při čtení příkladů kódu se často setkáte se symbolem komentáře ('). Tento symbol říká kompilátoru jazyka Visual Basic, aby ignoroval text, který následuje za ním, nebo komentář. Komentáře jsou stručné vysvětlující poznámky přidané do kódu pro výhody těch, kteří ho čtou.

Je vhodné programovat všechny postupy krátkým komentářem popisem funkčních charakteristik procedury (co dělá). To je pro vaši vlastní výhodu a výhodu kohokoli jiného, kdo kód prozkoumá. Podrobnosti implementace (jak to postup dělá) byste měli oddělit od komentářů, které popisují funkční charakteristiky. Pokud do popisu zahrnete podrobnosti implementace, nezapomeňte je aktualizovat při aktualizaci funkce.

Komentáře můžou následovat za příkazem na stejném řádku nebo zabírat celý řádek. Oba 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 pro komentování

Následující tabulka obsahuje obecné pokyny k tomu, jaké typy komentářů mohou předcházet části kódu. Jedná se o návrhy; Visual Basic nevynucuje pravidla pro přidávání komentářů. Napište, co funguje nejlépe– pro vás i pro všechny ostatní, kteří čtou váš kód.

Typ komentáře Popis komentáře
Účel Popisuje, co procedura dělá (ne jak to dělá).
Předpoklady Zobrazí seznam každé externí proměnné, ovládacího prvku, otevřeného souboru nebo jiného prvku, ke které přistupuje procedura.
Účinky Vypíše každou ovlivněnou externí proměnnou, ovládací prvek nebo soubor a efekt, který má (pouze pokud není zřejmé).
Vstupy Určuje účel argumentu.
Návraty Vysvětluje hodnoty vrácené postupem.

Zapamatujte si následující body:

  • Každá deklarace důležité proměnné by měla předcházet komentář popisující použití deklarované proměnné.

  • Proměnné, ovládací prvky a postupy by měly být pojmenovány dostatečně jasně, že komentování je potřeba pouze pro složité podrobnosti implementace.

  • Komentáře nemohou následovat sekvenci pokračování řádku ve stejném řádku.

Symboly komentáře pro blok kódu můžete přidat nebo odebrat tak, že vyberete jeden nebo více řádků kódu a na panelu nástrojů Upravit vyberete tlačítko The Visual Basic Comment button in Visual Studio.The Visual Basic Comment button in Visual Studio.Komentář () a The Visual Basic Uncomment button in Visual Studio.Odkomentování ()

Poznámka:

Komentáře můžete do kódu přidat také tak, že před text přidáte klíčové REM slovo. ' Symbol a tlačítka Pro/ se ale snadněji používají a vyžadují méně místa a paměti.

Viz také

  • Last updated on