Komentáre v jazyku JavaScript

Pre prehľadnejší obsah zdrojového kódu je možné tak, ako aj v iných programovacích jazykoch, používať komentáre. Komentáre predstavujú zápis informácií určených pre programátora, ktoré internetové prehliadače ignorujú a ich obsah nezobrazujú. V komentároch sa najčastejšie uvádzajú informácie k uvedenému programovému kódu, čím sa sprehľadňuje obsah zdrojového súboru a zároveň zjednodušuje pochopenie programovej logiky. Komentármi je zároveň možné deaktivovať a aktivovať jednotlivé časti programového kódu.

Zápis komentára v JavaScripte môže byť určený pre jednoriadkový alebo pre viacriadkový komentár. Jednoriadkový komentár sa inicializuje zápisom znakov //. Viacriadkový komentár sa umiestňuje medzi dvojicu znakov /* a */.

Príklad: Zápis jednoriadkového komentára.

1 // toto je jednoriadkový komentár, ktorého obsah sa nezobrazí

Pri jednoriadkovom komentári sa text za znakmi // až do konca riadku nezobrazí. Jednoriadkový komentár slúži pre vkladanie krátkych poznámok. Použitie znakov // je vhodné aplikovať aj na riadky programového kódu, ktoré vykazujú chyby. Postupným testovaním kódu a odstraňovaním znakov // z riadkov, ktoré boli v poriadku, je možné chybu rýchlejšie identifikovať.

Príklad: Zápis viacriadkového komentára.

1
2
3
4 /*
 Toto je viacriadkový komentár.
 Tento text sa v internetovom prehliadači nezobrazí.
*/

Text viacriadkového komentára môže byť aj v riadkoch so znakmi komentára. Takýto spôsob zápisu komentára sa z hľadiska coding style neodporúča.

Príklad: Neodporúčaný zápis viacriadkového komentára.

1
2 /* Toto je viacriadkový komentár.
Tento text sa v internetovom prehliadači nezobrazí. */

Pre sprehľadnenie a zároveň zvýraznenie viacriadkového komentára je možné použiť znak *.

Príklad: Zvýraznenie viacriadkového komentára.

1
2
3
4
5 /*
 * Toto je viacriadkový komentár so zvýraznením prostredníctvom znaku *.
 * Tento text a ani obsah sa v prehliadači nezobrazí.
 * document.write("Dokument XHTML s JavaScriptom v komentári.");
*/

Záver

Počet komentárov v programe nie je obmedzený. Môžu byť používané v rôznych častiach programu, všade tam, kde sú povolené biele miesta. V rámci praxe sa odporúča používať komentáre čo najčastejšie a čo najvýstižnejšie. Takto aplikované komentáre sa môžu stať v budúcnosti užitočným pomocníkom.

Záver

Komentáre

Pridať komentár