Komentarze JavaScript
Komentarze JavaScript mogą być użyte do wyjaśnienia kodu JavaScript i uczynienia go bardziej czytelnym.
Komentarze JavaScript mogą być również używane do zapobiegania wykonywaniu podczas testowania alternatywnego kodu.
Komentarze jednowierszowe
Komentarze jednowierszowe zaczynają się od //
.
Każdy tekst pomiędzy //
a końcem linii zostanie zignorowany przez JavaScript (nie zostanie wykonany).
W tym przykładzie zastosowano komentarz jednowierszowy przed każdą linią kodu:
Przykład
// Change heading:
document.getElementById("myH").innerHTML = "My First Page";
// Change paragraph:
document.getElementById("myP").innerHTML = "My first paragraph.";
W tym przykładzie zastosowano komentarz w jednym wierszu na końcu każdego wiersza, aby wyjaśnić kod:
Przykład
let x = 5; // Declare x, give it the value of 5
let y = x + 2; // Declare y, give it the value of x + 2
Komentarze wielowierszowe
Komentarze wielowierszowe zaczynają się /*
i kończą na */
.
Każdy tekst pomiędzy /*
i */
zostanie zignorowany przez JavaScript.
W tym przykładzie zastosowano komentarz wielowierszowy (blok komentarza) w celu wyjaśnienia kodu:
Przykład
/*
The code below will change
the heading with id = "myH"
and the paragraph with id = "myP"
in my web page:
*/
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
Najczęściej stosuje się komentarze jednowierszowe.
Komentarze blokowe są często używane w formalnej dokumentacji.
Używanie komentarzy w celu uniemożliwienia wykonania
Używanie komentarzy w celu uniemożliwienia wykonania kodu jest odpowiednie do testowania kodu.
Dodanie //
przed wierszem kodu zmienia wiersz kodu z wiersza wykonywalnego na komentarz.
W tym przykładzie użyto //, aby uniemożliwić wykonanie jednej z linii kodu:
Przykład
//document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
W tym przykładzie zastosowano blok komentarza, aby zapobiec wykonaniu wielu linii:
Przykład
/*
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
*/