Następny prosty temat o JavaScripcie będzie skupiony na komentarzach. Komentarze jakie znajdziecie w języku JavaScript to liniowy i blokowy. Parę akapitów szybko zleci, a przy okazji dowiecie się po co się je stosuje.

KOMENTARZE W JĘZYKU JAVASCRIPT MOGĄ CI SIĘ PRZYDAĆ

Komentarz to adnotacja programisty pisana ludzkim językiem, która ma na celu zwykle ułatwić zrozumienie przez drugą osobę co robi wskazana linijka kodu, blok kodu albo cały skrypt. Komentarze są całkowicie ignorowane przez interpreter, który jest w stanie je rozpoznać po charakterystycznym oznaczeniu. W zależności od wstawionego oznaczenia, wyróżniamy dwa rodzaje komentarzy.

KOMENTARZ LINIOWY

To jest komentarz obejmujący tylko jedną linijkę kodu (ładniej nazywana "wierszem"). Komentarz jednowierszowy powstaje w wyniku pozostawienia dwóch znaków "slash" (ukośników):

// To jest mój komentarz.

Po dwóch ukośnikach, możecie pisać co tam tylko chcecie. Przy czym zaznaczam, że to obejmuje tylko JEDEN wiersz! Gdy chcecie mieć więcej, to potrzebny będzie komentarz blokowy.

KOMENTARZ BLOKOWY

Komentarz blokowy (wielowierszowy) tworzy się już nieco inaczej, bowiem nie wystarczy pozostawienie oznaczenia w jednym miejscu. Musicie ustawić "początek" i "koniec" tego komentarza, coś jak start i meta w grach wyścigowych. "Start" robicie przy pomocy kombinacji znaków "slash" + asterysk nazywany "gwiazdką":

/*

parę linijek niżej dopisujecie odwrotną kombinację, żeby zasygnalizować "koniec":

*/

wówczas macie prawo wstawić cokolwiek, ale już w obrębie tych znaczników:

/*
To
jest
mój
komentarz.
*/

Ostrzegam, że nie możecie zagnieżdżać tych znaczników w sobie (wstawić tę samą parę wewnątrz). To już będzie błąd składniowy, czyli błąd łamiący zasady składni języka JavaScript!

UŻYWAĆ CZY NIE UŻYWAĆ?

To już zostawiam do Waszej refleksji. W wielu artykułach i książkach będziecie mieli grubą krechą zapisaną rekomendację, żeby komentarze w języku JavaScript stosować jak najczęściej. Ja ich nie stosuję już od kilku lat, gdyż staram się pisać kod w taki sposób, żeby sam dostarczał dostatecznych informacji bez "zwalania" tego obowiązku na komentarze. W pośpiechu można tylko zaktualizować kod zapominając o komentarzu przez co mogą powodować bałagan, zwiększać obszerność i sprawiać, że całość wygląda nieczytelnie. Dlatego nie stoję ani za, ani przeciw. Przedstawiłem swoje stanowisko, uzasadniłem, zaprezentowałem zagrożenia. Od tej pory decydujecie sami.

Komentarze w języku JavaScript

Komentarze w języku JavaScript dotyczą jednego wiersza (liniowy), bądź wielu wierszy (blokowy). Pozwalają one na wstawienie dowolnego tekstu niemającego nic wspólnego z instrukcjami do wykonania przez interpreter.


I to już finał tego skromnego artykułu o tym, po co znać komentarze w języku JavaScript i dlaczego należałoby zastanowić się, czy aby na pewno je stosować...

PODOBNE ARTYKUŁY