Następny prosty temat o języku JavaScript, który będzie skupiony na komentarzach. Komentarze jakie znajdziesz w języku JavaScript, to liniowy i blokowy. Parę akapitów szybko zleci, a przy okazji dowiesz 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 jakie występują w języku JavaScript:
- komentarz liniowy,
- komentarz blokowy.
Wyjaśnijmy je sobie 😊!
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żesz pisać co tylko chcesz przy czym zaznaczam, że to obejmuje tylko JEDEN wiersz! Gdy chcesz 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 ℹ️. Musisz ustawić "początek" i "koniec" tego komentarza, coś jak start i meta w grach wyścigowych 🏁. "Start" robisz przy pomocy kombinacji znaków "slash" + asterysk nazywany "gwiazdką":
/*parę linijek niżej dopisujesz odwrotną kombinację, żeby zasygnalizować "koniec":
*/wówczas masz prawo wstawić cokolwiek, tylko już w obrębie tych znaczników:
/*
To
jest
mój
komentarz.
*/Ostrzegam, że nie możesz 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!
CZY OPŁACA SIĘ STOSOWAĆ KOMENTARZE W KODZIE?
To już zostawiam do Twojej refleksji. W wielu artykułach i książkach będziesz mieć grubą krechą zapisaną rekomendację, żeby komentarze w języku JavaScript stosować jak najczęściej. Ja ich nie stosuję już dawna, 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 decydujesz sam(a).
 |
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ć ✅.