Komentarze w JavaScript

• Może 21, 2024

Komentarze są po prostu komentarzami umieszczonymi w JavaScript lub HTML, aby wyjaśnić, co się dzieje. Istnieje kilka sposobów umieszczania komentarzy w kodzie JavaScript. Składnia komentarzy - jak powiedzieć skryptowi lub dokumentowi, że coś jest komentarzem, a nie danymi lub kodem - jest bardzo prosta. Pisanie dobrych komentarzy jest trudniejsze, a patrząc na kod (w tym mój własny), wydaje się, że najtrudniejszą częścią tego jest robienie tego!

JavaScript ma 2 rodzaje komentarzy, komentarz jednowierszowy i komentarz wieloliniowy.

Komentarz jednowierszowy w JavaScript zaczyna się od dwóch ukośników do przodu (//) i kończy na końcu wiersza (technicznie rzecz biorąc, bezpośrednio przed znakiem kończącym wiersz). Komentarze w jednym wierszu są szczególnie przydatne w przypadku krótkich notatek.

// To jest komentarz jednowierszowy
data = "moje dane" // To jest także komentarz jednowierszowy

Wieloliniowy komentarz w JavaScript zaczyna się od ukośnika, po którym następuje gwiazdka (/*) i kończy się gwiazdką, a następnie ukośnikiem (*/). Wszystko pomiędzy /* i */ jest uważany za komentarz. Ten typ komentarza może obejmować wiele wierszy. Możliwe jest również umieszczenie tego typu komentarza w środku wiersza kodu, jeśli nie obejmuje on wielu wierszy, ale rzadko jest to przydatne.

/ * to jest pierwszy wiersz komentarza zawierającego wiele wierszy
to wciąż część mojego komentarza
to jest ostatnia część mojego komentarza * /

/ * to jest komentarz w stylu wielu linii na jednej linii * /

Często dodaje się dodatkowe gwiazdki do komentarzy wieloliniowych, aby tworzyć dekoracyjne pola informacyjne, takie jak:

/*********************
* Moje funkcje *
*********************/

Funkcje wieloliniowe są szczególnie przydatne na początku programu lub jego części, aby opisać, co program ma zrobić i jak to robi.

Komentarze są wykorzystywane do dwóch celów. Podczas pisania kodu (a nawet zanim go napiszesz) powinieneś pisać komentarze, które pozwolą innej osobie zrozumieć, co program robi (lub powinien robić). Nawet jeśli nie spodziewasz się, że ktokolwiek będzie czytał kodu, zdziwisz się, ile możesz zapomnieć, jeśli chcesz wprowadzić zmiany po kilku tygodniach lub miesiącach.

Ponadto, szczególnie w językach skryptowych, takich jak JavaScript, komentarze są często używane jako część procesu debugowania. Możesz wprowadzić kod używany do debugowania i skomentować go, gdy skończysz go używać, lub skomentować sekcje kodu, które Twoim zdaniem powodują problemy lub zmieniają się w celu dodania nowej funkcjonalności. Robiąc to, należy szczególnie uważać, aby nie umieszczać komentarza w jednym wierszu przed początkiem komentarza w wielu wierszach. Odkomentuje to resztę komentarza wieloliniowego, co prawie na pewno spowoduje błąd.

Instrukcje Wideo: Komentarze Javascript - po co są komentarze? (Może 2024).