Kurs JavaScript - Kod - Komentarze  Udostępnij na: Facebook

Autor: Bożena Jurczyk

Opublikowano: 2011-12-12

Podczas projektowania i tworzenia strony internetowej, z pewnością dokładnie potrafisz opisać, za co ma odpowiadać dany fragment kodu. Wyobraź sobie jednak, że za jakiś czas będziesz chciał wprowadzić do niego pewne modyfikacje lub Twój kawałek kodu będzie analizowany przez inne osoby. Czy będziesz wówczas potrafił szybko odnaleźć odpowiednie miejsce i dokonać tych zmian? Właśnie dlatego powinieneś zawsze opisywać przynajmniej ważniejsze fragmenty swojego kodu. W języku JavaScript istnieje również możliwość dodawania komentarzy.

Przed wykonaniem zadań powinieneś wiedzieć:

Po wykonaniu zadań nauczysz się:

  • opisywać kod JavaScript za pomocą komentarzy.

Implementacja

W przeglądarce Internet Explorer (od wersji 8) otwórz stronę internetową jTest.html, znajdującą się w pliku JavaScript.zip. Jeśli nie możesz pobrać pliku, to sprawdź to zagadnienie w encyklopedii pod hasłem Jak przygotować stronę samouczka JavaScript.

Wpływ komentarza na działanie skryptów

Celem pierwszego zadania jest sprawdzenie, jaki wpływ mają komentarze na działanie skryptu.

  1. Otwórz stronę internetową jTest.html, wciśnij przycisk F12 lub wybierz Tools­>F12 developer tools.
  2. W pojawiającym się oknie, kliknij na zakładkę Script (oznaczoną 1 na Rys.1.), a następnie w wierszu, w prawym dolnym rogu (oznaczonym 2 na Rys. 1.), wpisz:
val1 = document.getElementById('pokaz');
val2 = 'Witaj'; // tu możemy opisać jaką rolę pełni zmienna val2
//val2 = 'Hello';
val1.innerHTML = val2;

Rys. 1. Narzędzia programistyczne do języka JavaScript w Internet Explorer 9.

  1. Wciśnij Enter lub przycisk Run Script.
  2. Na stronie, poniżej nagłówka "Samouczek JavaScript", powinien pojawić się napis "Witaj" (Rys. 2.).

Rys.2. Wyświetlenie napisu na stronie w języku JavaScript.

Informacja

Zgodnie z oczekiwaniami, zakomentowany fragment kodu nie miał wpływu na wykonanie dalszego skryptu. Zmiana wartości val2 na "Hello" nie została zrealizowana w kodzie.

Tak jak w powyższym przykładzie, komentarze w JavaScript mogą zaczynać się znakami "//", które powodują zakomentowanie kodu, występującego po tych znakach do końca danej linii.

Komentarz wielowierszowy

Innym sposobem, pozwalającym na zakomentowanie bloku kodu, czyli więcej niż jednej linii, to użycie znaku rozpoczęcia komentarza "/*" oraz zakończenia "*/". Wszystko pomiędzy tymi znakami traktowane będzie jako komentarz i oczywiście nie będzie miało żadnego wpływu na wykonanie kodu.

  1. Otwórz okno narzędzi programistycznych przeglądarki Internet Explorer, w prawym dolnym rogu (oznaczonym 2 na Rys. 1.) i wpisz:
val1 = document.getElementById('pokaz');
/*
    W takim bloku możesz np. zawrzeć podstawowe informacje
    o autorze kodu. Poniżej dalszy kod skryptu...   
*/
val1.innerHTML = 'Witaj wielowierszowo';
  1. Wciśnij Enter.
  2. Wynik powinien być podobny jak poprzednio, czyli na stronie powinien pojawić się napis "Witaj wielowierszowo”.

Rys.3. Wyświetlenie napisu na stronie w języku JavaScript z komentarzem wielowierszowym.

Informacja
Jak widać nie ma znaczenia, w ilu wierszach znajduje się komentarz. Nie ma też potrzeby komentowania pojedynczych linii.

Formatowanie komentarzy

Wiele osób dba o to, aby pisane przez nich komentarze były ładnie sformatowane, dzięki czemu oprócz opisywania kodu, powodują że jest bardziej czytelny.

  1. Otwórz okno narzędzi programistycznych przeglądarki Internet Explorer, w prawym dolnym rogu (oznaczonym 2 na Rys. 1.) i wpisz:
val1 = document.getElementById('pokaz');
/************************************************
 * Tutaj umieścimy komentarz, otoczony ramką,    *
 * dzięki czemu wyróżnia się w kodzie.           *
 *************************************************/
val1.innerHTML = 'Witaj formatowanie';
  1. Wciśnij Enter.
  2. Wynik powinien być podobny, jak poprzednio, czyli na stronie powinien pojawić się napis "Witaj formatowanie".

Rys.4. Wyświetlenie napisu na stronie w języku JavaScript z komentarzem dotyczącym formatowania.

Podsumowanie

W tym samouczku nauczyłeś się, jak używać komentarzy w języku JavaScript. Pamiętaj, że komentarze, w swej prostocie stosowania, bardzo mogą Ci pomóc , aby dobrze orientować się w Twoim kodzie, dlatego zawsze używaj ich do opisywania przynajmniej ważniejszych funkcjonalności Twojego kodu.

W kolejnym samouczku zdobędziesz wiedzę na temat operatorów, stosowanych w języku JavaScript, Kod JavaScript – operatory.

Dodatkowo zobacz: