CKTIS / JavaScript
Komentarji in dokumentacija
Komentarji opisujejo namen kode, ne da bi se njihova vsebina izvajala. Spoznajte zapis // in /* ... */, dokumentacijsko konvencijo /** ... */ ter vpliv zaključkov vrstic na razčlenjevanje programa.
Različica: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Sintaksa
// comment
/* block comment */
/** documentation comment */Komentarji pojasnjujejo kodo, zlasti razloge za odločitve in omejitve. Njihova vsebina se ne izvaja kot JavaScript. Uredniško priporočilo: pojasnite predvsem »zakaj«, namesto da ponavljate, kaj počne očiten stavek.
// začne komentar, ki sega do konca vrstice ali izvornega besedila; zaključek vrstice ni del komentarja. /* ... */ lahko zavzame del vrstice ali več vrstic in se konča pri prvem */. Blokovni komentarji se ne morejo gnezditi.
Za ECMAScript je /** ... */ navaden blokovni komentar. Dokumentacijski zapis ne spremeni delovanja funkcije in ne vsili tipov; razlaga dodatnih opomb je naloga orodij, ne del jezikovne sintakse.
Komentarji se obnašajo kot beli presledki, z pomembno izjemo: blokovni komentar, ki vsebuje zaključek vrstice, se pri skladenjskem razčlenjevanju obravnava kot zaključek vrstice. To lahko vpliva na samodejno vstavljanje podpičij (ASI), na primer za return. S takim komentarjem ne ločujte return od vrnjene vrednosti. Ločena oblika #! je dovoljena samo na samem začetku izvornega besedila Script ali Module.
Primeri
/** 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);Rezultat
21
Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.