Počítačový programovací jazyk Microsoft Visual Basic je v programovacích kruhoch obľúbený už mnoho rokov. Programátori ho používajú na všetky druhy projektov. Varianty tohto programovacieho jazyka sa používajú pre webové stránky a iné typy programov Visual Basic sa používajú pre mnoho aplikácií Windows, ktoré používame každý deň. Jedným zo základných prvkov jazyka Visual Basic je možnosť zahrnúť komentáre, čo sú poznámky vložené do kódu, ktoré nemajú účel funkčného kódu. Visual Basic používa špecifický protokol na ich rozlíšenie od kódu. Pridávanie komentárov je vo väčšine projektov mimoriadne dôležité, aby pomohli divákom ľudského kódu správne prečítať moduly kódu. Ak potrebujete pridať komentáre do jazyka Visual Basic, tu sú niektoré zo základných krokov, ako sa uistiť, že to robíte správne.
Kroky
Krok 1. Určte, ktorý typ komentára chcete pridať
Programátori majú niekoľko rôznych hlavných účelov pre komentáre, ktoré určujú presný formát a štýl toho, čo bude zahrnuté v komentári.
- Zvážte pripomienky modulu kódu. Komentáre k modulom sú komentáre na vyššej úrovni, ktoré zvyčajne opisujú celkové účely modulu kódu a ďalšie informácie, ako sú autorské práva, autorstvo a ďalšie.
- Posúďte potrebu pripomienok k postupu. Tiež by mali byť komentované rôzne procedúry funkčného kódu. Komentáre k postupu sa týkajú konkrétnych funkcií kódu a pomáhajú upozorniť ostatných programátorov na presné výsledky postupu podľa toho, ako je napísaný.
Krok 2. Vyberte si podrobné kategórie použitia pre komentáre k kódu
Niektoré typy komentárov, ako napríklad komentáre k postupu, majú tiež rôzne formy. Pochopte tieto rôzne použitia, aby ste do svojho programu mohli pridať správne druhy komentárov.
- Posúďte použitie účelových komentárov k postupom. Tieto popisujú, čo postup robí.
- Zvážte použitie komentárov k návratovým hodnotám funkcií. Pomôžu ostatným pochopiť, aké hodnoty sú postupom vrátené.
- Zahrňte podmienené komentáre. Podmienené komentáre môžu popisovať možné chybové stavy a spracovanie chýb, ako aj podmienky, ktoré je potrebné splniť, aby kód správne fungoval.
Krok 3. Vyberte formát komentárov
Je tu tiež problém, ako budete pridávať komentáre ku konkrétnym riadkom kódu.
- Využite komentáre pre ľavákov. Tieto komentáre začínajú na ľavej strane obrazovky a pokračujú celou čiarou. Kodér spravidla musí svojvoľne ukončiť komentár v blízkosti pravej strany obrazovky, prejsť na nový riadok a pokračovať v komentári.
- Používajte in-line komentáre. Riadkové komentáre majú apostrof priamo za kusom kódu a sú umiestnené na rovnakom riadku.
Krok 4. Apostrofom označte začiatok svojich komentárov
Toto je kľúčový krok pre skutočné písanie komentárov do kódu. Apostrof je špecifický textový protokol, ktorý kompilátor Visual Basic rozpoznáva pre komentáre. Bez toho sa počítač pokúsi prečítať komentáre ako kód.
