Počítačový programovací jazyk Microsoft Visual Basic je v programovacích kruzích oblíbený již mnoho let. Programátoři jej používají pro všechny druhy projektů. Varianty tohoto programovacího jazyka se používají pro webové stránky a jiné typy programů Visual Basic se používají pro mnoho aplikací Windows, které používáme každý den. Jedním ze základních prvků jazyka Visual Basic je možnost zahrnout komentáře, což jsou poznámky vložené do kódu, které nemají účel funkčního kódu. Visual Basic používá konkrétní protokol k jejich rozlišení od kódu. Přidávání komentářů je ve většině projektů nesmírně důležité, aby diváci lidského kódu mohli správně číst moduly kódu. Pokud potřebujete přidat komentáře do jazyka Visual Basic, zde jsou některé ze základních kroků, jak se ujistit, že to děláte správně.
Kroky
Krok 1. Určete, jaký typ komentáře chcete přidat
Programátoři mají několik různých hlavních účelů pro komentáře, které určují přesný formát a styl toho, co bude do komentáře zahrnuto.
- Zvažte komentáře modulu kódu. Komentáře k modulu jsou komentáře vyšší úrovně, které obvykle popisují celkové účely modulu kódu a další informace, jako jsou autorská práva, autorství a další.
- Posuďte nutnost komentářů k postupu. Rovněž je třeba komentovat různé procedury funkčního kódu. Komentáře k procedurám se týkají konkrétních funkcí kódu a pomáhají upozornit ostatní programátory na přesné výsledky postupu podle toho, jak je napsán.
Krok 2. Vyberte podrobné kategorie použití pro komentáře ke kódu
Některé typy komentářů, například komentáře k procedurám, mají také různé formy. Pochopte tato různá použití, abyste do svého programu mohli přidat správné druhy komentářů.
- Posoudit použití účelových komentářů k postupům. Popisují, co postup dělá.
- Zvažte použití komentářů k návratové hodnotě funkce. Pomohou ostatním pochopit, jaké hodnoty jsou vráceny procedurou.
- Zahrňte podmíněné komentáře. Podmíněné komentáře mohou popisovat možné chybové podmínky a zpracování chyb, jakož i podmínky, které musí být splněny, aby kód fungoval správně.
Krok 3. Vyberte formát pro komentáře
Existuje také problém, jak budete přidávat komentáře ke konkrétním řádkům kódu.
- Využijte levácké komentáře. Tyto komentáře začínají v levé části obrazovky a pokračují po celé čáře. Kodér obvykle potřebuje libovolně ukončit komentář v blízkosti pravé strany obrazovky, přejít dolů na nový řádek a pokračovat v komentáři.
- Používejte in-line komentáře. Řádkové komentáře mají apostrof přímo za kusem kódu a jsou umístěny na stejném řádku.
Krok 4. Pomocí apostrofu označte začátek vašich komentářů
Toto je klíčový krok pro skutečné psaní komentářů do kódu. Apostrof je specifický textový protokol, který kompilátor jazyka rozpoznává pro komentáře. Bez toho se počítač pokusí přečíst komentáře jako kód.
