Komentáre v JavaScripte

• Apríl 27, 2024

Komentáre sú len komentáre, ktoré vložíte do svojho JavaScriptu alebo HTML na vysvetlenie, čo sa deje. Existuje niekoľko spôsobov, ako vložiť komentáre do kódu JavaScript. Syntax komentára - ako povedať skriptu alebo dokumentu, že niečo je komentár a nie dáta alebo kód - je veľmi jednoduché. Písanie dobrých komentárov je ťažšie a z pohľadu na kód (vrátane mojej vlastnej) sa zdá, že najťažšia časť je v skutočnosti!

JavaScript má 2 typy komentárov, jednoriadkový komentár a viacriadkový komentár.

Jednoriadkový komentár v JavaScripte začína dvoma lomkami (//) a končí na konci riadku (technicky bezprostredne pred znak ukončenia riadku). Jednoriadkové komentáre sú užitočné najmä pre krátke poznámky.

// Toto je jednoriadkový komentár
data = "my data" // Toto je tiež jednoriadkový komentár

Viacriadkový komentár v JavaScripte začína lomkou nasledovanou hviezdičkou (/*) a končí hviezdičkou, za ktorou nasleduje lomka (*/). Všetko medzi /* a */ sa považuje za komentár. Tento typ komentára môže pokrývať niekoľko riadkov. Je tiež možné vložiť tento typ komentára do stredu riadku kódu, ak nie je obsiahnutý vo viacerých riadkoch, ale je to zriedka užitočné.

/ * toto je riadok jeden z viacerých riadkov
toto je stále časť môjho komentára
toto je posledná časť môjho komentára * /

/ * toto je komentár viacerých štýlov na jednom riadku * /

K viacriadkovým komentárom sa často pridávajú ďalšie hviezdičky, aby ste vytvorili ozdobné informačné polia, ako napríklad:

/*********************
* Moje funkcie *
*********************/

Viacriadkové funkcie sú obzvlášť užitočné na začiatku programu alebo časti programu na opis toho, čo má program robiť a ako to robí.

Komentáre sa používajú na dva účely. Keď píšete kód (alebo ešte predtým, ako ho píšete!), Mali by ste písať komentáre, ktoré umožnia inej osobe pochopiť, čo program robí (alebo mal robiť). Dokonca aj keď neočakávate, že niekto iný číta niekedy váš kód, budete prekvapení, koľko môžete zabudnúť, ak chcete vykonať zmeny po niekoľkých týždňoch alebo mesiacoch.

Tiež, najmä v skriptovacích jazykoch, ako je JavaScript, sa komentáre často používajú ako súčasť procesu ladenia. Môžete vložiť kód, ktorý sa má použiť na ladenie, a komentovať ich, keď ich budete používať, alebo komentovať časti kódu, o ktorých si myslíte, že spôsobujú problémy alebo sa menia s cieľom pridať novú funkciu. Keď to urobíte, buďte obzvlášť opatrní, aby ste pred riadok pred viacriadkovým komentárom nevložili jednoriadkový komentár. Tým sa odloží zvyšok viacriadkového komentára, ktorý takmer určite spôsobí chybu.

Video Návody: Web developerská škola, časť 9: JavaScript - Komentáre (Apríl 2024).