W chwili pisania skryptu wszystko może ci się wydawać oczywiste i zrozumiałe, jednak gdy powrócisz do niego po dłuższym czasie może się okazać (a nawet się okaże), że nic z niego nie rozumiesz (i uwierzcie mi - bo sam przez to przechodziłem).
Komentarze istnieją właśnie po to aby uniknąć takiej sytuacji.
Javascript umożliwia wstawianie dwóch typów komentarzy:
Pierwszy z nich wstawiamy do skryptu poprzez umieszczenie go za dwoma ukośnikami //. Taki komentarz możemy umieścić tylko w jednej linni - za wspomnianymi ukośnikami.
Drugi sposób tworzenia komentarza polega na tym że nasz komentarz musi być rozpoczęty od znaków /* i kończyć się znakami */. Taki komentarz może mieć już kilkanaście linijek.
Poniżej przedstawiam przykładowy skrypt z komentarzami:
<script type="text/javascript">
/*
To jest przykład
komentarza
wielolinijkowego */
var liczba = 10; //to jest komentarz jednolinijkowy
document.write(liczba);
//a ponizej male rownanko
document.write("kwadrat liczby " + liczba + " równa sie " + (liczba*liczba));
</script>
A oto jeszcze jeden przykład skryptu z zastosowanymi komentarzami:
<script type="text/javascript">
/*
* wypiszemy Hello World!
* gdyż takie słowa wypisują
* pierwsze skrypty
* w większości kursów
*/
document.write("Hello World!"); //Napis Hello World! ukaże się w oknie przeglądarki
</script>
Częstokroć większe skrypty korzystają z komentarzy które są ładnie sformatowane. Dzięki temu łatwiej takie opisy znaleĽć w gąszczu linijek dziwnie wyglądającego kodu:
<script type="text/javascript">
/*
******************************
* wypiszemy Hello World! *
* gdyż takie słowa wypisują *
* pierwsze skrypty *
* w większości kursów *
******************************/
document.write("Hello " + "World" + "!"); //Napis Hello World! ukaże się w oknie przeglądarki
</script>
dobrym rozwiązaniem jest też komentowanie działania i wywołania funkcji:
<script type="text/javascript">
//*****************************
// Funkcja zwraca kwadrat liczby podanej w argumencie
// x - liczba do podniesienia do kwadratu
// wywolanie np: var liczba = kwadrat(2);
//*****************************
function kwadrat(x) {
return x*x;
}
</script>