Komentáře v kódu (Visual Basic)
Při čtení příklady kódu, často setkáte symbol komentáře (').Tento symbol je uvedeno Visual Basic Kompilátor ignoruje textu, nebo Komentář.Poznámky jsou stručné vysvětlující poznámky přidané do kódu pro prospěch z těchto čtení.
Je dobré praxe začínat stručný komentář popisující funkční charakteristiky postupu (akce) všech postupů programování.To je pro svůj vlastní prospěch a výhody nikdo, kdo kontroluje kód.Podrobnosti o implementaci (postup jak ji) je vhodné oddělit od komentáře, které popisují funkční charakteristiky.Když zahrnete popis podrobnosti implementace, nezapomeňte je aktualizovat při aktualizaci funkce.
Komentáře můžete podle prohlášení na stejném řádku nebo obsadit celý řádek.Obě 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ář 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 přidávání poznámek
Následující tabulka obsahuje obecné pokyny pro jaké typy poznámek lze předcházet části kódu.Jedná se o návrhy; Visual Basicnevynucuje pravidla pro přidávání poznámek.Napište co nejlépe, můžete i pro nikdo, kdo čte váš kód.
Typ poznámky |
Popis komentáře |
Účel |
Popisuje postup nemá (není to jak ji) |
Předpoklady |
Každý externí uvádí proměnné, řízení, otevřít soubor nebo jiný prvek, který přistupuje k postupu |
Efekty |
Seznamy jednotlivých ovlivněny externí proměnné, řízení nebo soubor a efekt, který má (pouze pokud není zřejmé) |
Vstupy |
Určuje účel argument |
Výsledek |
Hodnoty vrácené procedurou vysvětluje |
Mějte na paměti následující body:
Každé důležité deklarace proměnné by mělo předcházet komentář popisující použití proměnné jsou deklarovány.
Proměnné, ovládací prvky a postupy pojmenování dostatečně jasně, že komentáře je nutné pouze pro podrobnosti provádění složitých.
Poznámky nelze sledovat posloupnosti pokračování řádku na stejném řádku.
Můžete přidat nebo odebrat komentář symboly pro blok kódu výběrem jednoho nebo více řádků kódu a klepnutím Komentář (.gif "VisualBasicWinAppCodeEditorCommentButton")
) a Uncomment (.gif "VisualStudioWinAppProjectUncommentButton")
) na tlačítka Upravit nástrojů.
[!POZNÁMKA]
Můžete také přidat komentáře kódu podle předcházející text s REM klíčové slovo.Však ' symbol a Komentář/Uncomment tlačítka jsou jednodušší a vyžadují méně místa a paměti.