Komentáře v JavaScriptu

• Smět 15, 2024

Komentáře jsou pouze komentáře, které vložíte do JavaScriptu nebo HTML, aby vysvětlili, co se děje. Existuje několik způsobů, jak vložit komentáře do kódu JavaScript. Syntaxe komentáře - jak říct skriptu nebo dokumentu, že něco je komentář a ne data nebo kód - je velmi jednoduché. Psaní dobrých komentářů je těžší a z pohledu na kód (včetně mých vlastních) se zdá, že nejtěžší část to vlastně je!

JavaScript má 2 typy komentářů, jeden řádkový komentář a víceřádkový komentář.

Jediný řádkový komentář v JavaScriptu začíná dvěma lomítkami (//) a končí na konci řádku (technicky bezprostředně před znakem ukončení řádku). Jednořádkové komentáře jsou zvláště užitečné pro krátké poznámky.

// Toto je jednorozměrný komentář
data = "moje data" // Toto je také komentář k jednomu řádku

Víceřádkový komentář v JavaScriptu začíná lomítkem následovaným hvězdičkou (/*) a končí hvězdičkou následovanou lomítkem (*/). Všechno mezi /* a */ je považován za komentář. Tento typ komentáře může zahrnovat více řádků. Je také možné vložit tento typ komentáře do středu řádku kódu, pokud není překlenut více řádků, ale je to zřídka užitečné.

/ * toto je řádek jeden z víceřádkového komentáře
toto je stále část mého komentáře
toto je poslední část mého komentáře * /

/ * toto je víceřádkový komentář na jednom řádku * /

K víceřádkovým komentářům se často přidávají další hvězdičky k vytvoření dekorativních informačních polí, jako například:

/*********************
* Moje funkce *
*********************/

Víceřádkové funkce jsou zvláště užitečné na začátku programu nebo části programu k popisu toho, co má program dělat a jak to dělá.

Komentáře se používají pro dva účely. Když píšete kód (nebo ještě předtím, než ho píšete!), Měli byste psát komentáře, které umožní jiné osobě porozumět tomu, co program dělá (nebo měl dělat). I když neočekáváte, že někdo jiný někdy přečte váš kód, budete překvapeni, kolik můžete zapomenout, pokud chcete provést změny po několika týdnech nebo měsících.

Také, zejména ve skriptovacích jazycích, jako je JavaScript, se komentáře často používají jako součást procesu ladění. Můžete vložit kód, který chcete použít pro ladění, a komentovat je, když jste hotovi, nebo vyřadit části kódu, o kterých si myslíte, že způsobují problémy nebo se mění přidáním nové funkce. Když tak učiníte, buďte obzvláště opatrní, abyste na řádek před začátek víceřádkového komentáře nevkládali jeden řádek. Tím se oddělí zbytek víceřádkového komentáře, což téměř jistě způsobí chybu.

Video Návody: Programování hry miny v JavaScriptu [Timelapse] (Smět 2024).