CKTIS / JavaScript
Komentáre a dokumentácia
Komentáre opisujú zámer kódu bez toho, aby sa ich obsah vykonával. Spoznajte zápis // a /* ... */, dokumentačnú konvenciu /** ... */ a vplyv koncov riadkov na syntaktickú analýzu programu.
Verzia: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
// comment
/* block comment */
/** documentation comment */Komentáre vysvetľujú kód, najmä dôvody rozhodnutí a obmedzenia. Ich obsah sa nevykonáva ako JavaScript. Redakčné odporúčanie: vysvetľujte predovšetkým „prečo“, namiesto opakovania toho, čo robí zrejmý príkaz.
// začína komentár, ktorý pokračuje do konca riadka alebo zdrojového textu; znak konca riadka nie je súčasťou komentára. /* ... */ môže zaberať časť riadka alebo viac riadkov a končí sa pri prvom */. Blokové komentáre sa nedajú vnárať.
Pre ECMAScript je /** ... */ obyčajný blokový komentár. Dokumentačný zápis nemení správanie funkcie ani nevynucuje typy; interpretácia ďalších anotácií patrí nástrojom, nie syntaxi jazyka.
Komentáre sa správajú ako biele znaky, s dôležitou výnimkou: blokový komentár obsahujúci znak konca riadka sa pri syntaktickej analýze považuje za koniec riadka. Môže to ovplyvniť automatické vkladanie bodkočiarky (ASI), napríklad po return. Takýmto komentárom neoddeľujte return od vracanej hodnoty. Samostatná forma #! je povolená iba na úplnom začiatku zdrojového textu Scriptu alebo Modulu.
Príklady
/** Compute the total price. */
function total(price, quantity) {
// Keep the calculation in one place.
return price * quantity;
}
const result = total(7, /* quantity */ 3);
console.log(result);Výsledok
21
Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.