Kurs obiektowego JavaScript (9)

Autor: Damian Chodorek • Opublikowany: 27 września 2014 • Ostatnia aktualizacja: 8 lutego 2015 • Kategoria: javascript, kursy

Komentowanie kodu i tworzenie dokumentacji.

Wygląda jak w innych, znanych językach programowania. Komentarze są kompletnie ignorowane przez interpreter JS. Mają one jednak ogromne znaczenie. Służą przede wszystkim do dokumentowania własnego kodu, tak aby był on zrozumiały dla nas samych oraz innych. Wyróżniamy dwa rodzaje komentarzy:

  • jedno-liniowe komentarze,
  • wielo-linowe komentarze.
var a=1; //komentarz, który trwa do końca wiersza

/*
to komentarz
wielo-liniowy
*/

Pierwszy rodzaj zaczyna się od znaków // i kończy się wraz z końcem danego wiersza. Drugi rodzaj komentarzy rozpoczyna się /*, a kończy */. To znaczy, że jeśli zrobisz /*, ale zapomnisz */, to cały kod od rozpoczęcia /* będzie pominięty. W praktyce dostaniesz jednak błąd SyntaxError: Unexpected token ILLEGAL.

Używając odpowiednio komentarzy, można łatwo stworzyć dokumentację programu. Przykładowo korzystając z JSDoc.

W tym artykule to wszystko. Przejdź do następnej części:

Kurs obiektowego JavaScript (10)

Zobacz również
Kurs obiektowego JavaScript (7)Podstawowe informacje o tablicach.
Kurs obiektowego JavaScript (8)Bloki warunkowe oraz pętle w JS.
Kurs obiektowego JavaScript (10)Omówienie funkcji, sposobów przekazywania parametrów oraz kilku przydatnych funkcji wbudowanych.
Kurs obiektowego JavaScript (11)Zmienne globalne. Nietypowy zakres zmiennych lokalnych.

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.