Komentarze w JavaScripcie pozwalają na dokumentację skryptu wewnątrz kodu. Przydaje się to, gdy ktoś inny chce zrozumieć działanie skryptu lub nawet gdy jego autor po dłuższej przerwie chce powrócić do kodu. Poniżej zaprezentowana jest konstrukcja komentarza jednowierszowego w JavaScripcie.
// treść komentarzaKomentarz można też umieszczać w środku wiersza. W takim wypadku wszystko od ukośników do końca wiersza jest traktowane jako komentarz i ignorowane przy wykonywaniu skryptu, np.:
a = a + b // treść komentarzaJavaScript obsługuje też komentarze w stylu języka C, przykład zaprezentowany jest poniżej:
/* treść komentarza */Taki styl komentarza może obejmować jeden lub więcej wierszy.
Nie można zagnieżdżać komentarzy – czyli umieszczać jednego komentarza wewnątrz innego.
Komentarze dokumentacyjne JSDoc
Osobną odmianą komentarza blokowego jest komentarz dokumentacyjny zaczynający się od /**. Opisuje funkcję w formacie JSDoc, który rozumieją edytory: VS Code podpowiada wtedy typy parametrów i opis przy każdym wywołaniu, nawet w czystym JavaScripcie bez TypeScriptu:
/**
* Liczy cene brutto na podstawie ceny netto.
*
* @param {number} netto cena netto produktu
* @param {number} stawka stawka VAT, np. 0.23
* @returns {number} cena brutto
*/
function brutto(netto, stawka = 0.23) {
return netto * (1 + stawka);
}Najczęściej używane znaczniki to @param, @returns i @deprecated (edytor przekreśli wywołania oznaczonej funkcji).
Szybkie komentowanie i wykomentowywanie kodu
W praktyce komentarze służą też do chwilowego wyłączania kodu podczas szukania błędu. Każdy edytor robi to jednym skrótem: zaznaczamy linie i wciskamy Ctrl + / (na Macu Cmd + /), ten sam skrót zdejmuje komentarz. Blokowy wariant to Shift + Alt + A w VS Code.
Uwaga na komentarze HTML w skryptach
W starych poradnikach można spotkać kod JavaScript owinięty w <!-- -->. To relikt lat 90., gdy przeglądarki bez obsługi skryptów wypisywały ich treść na stronie. Dziś taki zapis jest zbędny, a wewnątrz plików .js wręcz błędny: komentarze HTML należą do HTML, w JavaScripcie używamy wyłącznie // i /* */.
Dobry i zły komentarz
Zasada jest ta sama co w każdym języku: dobry komentarz wyjaśnia DLACZEGO, zły powtarza to, co widać w kodzie:
licznik++; // zwieksza licznik o 1 <- zly: powtarza kod
cena *= 1.08; // stawka 8% dla transportu (ustawa o VAT) <- dobry: wyjasnia "dlaczego"Największym grzechem pozostaje komentarz nieaktualny, opisujący kod sprzed zmian. Zmieniasz kod, zmień komentarz obok, a jeżeli tylko powtarza kod, po prostu go usuń. Te same zasady opisałem dla komentarzy w PHP, gdzie składnia jest niemal identyczna.



// brak komentarzy — bądź pierwszy