Komentarz JavaScript

Michael Zippo

Komentarze JavaScript służą do pisania notatek w kodzie lub wyłączania sekcji kodu bez ich usuwania. Komentarze są tworzone w JavaScript przez dodanie // przed pojedynczą linią lub / * przed i * / po wielu wierszach.

Komentowanie kod jest podstawową cechą wielu języków programowania. Ideą komentarzy do kodu jest to, że podczas gdy Twój kod będzie czytany przez komputer, Twój kod będzie również czytany przez ludzi, dlatego ważne jest, aby ludzie mogli łatwo zrozumieć kod, który piszesz.

Komentarze pozwalają możesz śledzić swój kod podczas programowania i dać ci możliwość robienia notatek, które mogą być przydatne w przyszłości. Ponadto, jeśli pracujesz w zespole, pisanie komentarzy pomoże zapewnić, że Twój kod będzie czytelny dla każdego, kto może potrzebować przyczynić się do Twojej pracy.

W tym samouczku omówimy, jak pisać komentarze w JavaScript. Zaczniemy od omówienia wartości komentarzy w JavaScript, a następnie przyjrzymy się składni, której można użyć do pisania komentarzy w JavaScript.

Komentarze pisanie o kodzie

O temat jest istotną częścią pisania kodu, który jest czytelny i łatwy w zarządzaniu. Prawda jest taka, że jeśli potrafisz zrozumieć kod, który piszesz dzisiaj, nie ma gwarancji, że będziesz w stanie skutecznie opisać to, co robi jutro. Ponadto, jeśli pracujesz z innymi ludźmi, jest bardzo prawdopodobne, że nie rozumieją oni części kodu, który piszesz.

tam są komentarze. Komentarze to stwierdzenia, które są ignorowane przez kompilator i można wykorzystać do wyjaśnienia kodu JavaScript.

Jako programista, pisanie komentarzy do kodu pozwoli Ci skuteczniej śledzić to, co robisz. Podczas pisania kodu możesz pisać notatki, które pomogą ci lepiej zrozumieć kod i zrozumieć intencje kryjące się za kodem, który napisałeś wcześniej. Pisanie komentarzy będzie również przydatne dla innych osób, które mogą zobaczyć Twój kod, ponieważ komentarz prawdopodobnie pomoże im lepiej zrozumieć, jak Twój kod działa.

Każdy programista pisze komentarze inaczej , ale ogólna zasada jest to, że komentarze powinny być używane do wyjaśnienia intencji twojego kodu. W końcu twój kod mówi sam za siebie, ale powody pisania kodu w określony sposób często nie. Dlatego pisząc komentarze, możesz wyjaśnić, dlaczego podszedłeś do problem w pewien sposób, co ułatwia Tobie i innym zrozumienie, jak Twój program działa później.

Komentarze JavaScript

Są dwa rodzaje komentarzy używanych w JavaScript:. Komentarze jednowierszowe i komentarze blokowe

Komentarze jednowierszowe są zapisywane przy użyciu dwóch ukośników (//) i są zapisywane w jednym wierszu kodu. Każdy znak następujący po deklaracji "//" będzie ignorowany do końca linii. Oto przykład komentarza w jednym wierszu w JavaScript:

// To jest komentarz w wierszu

blok jest napisany z otwarciem i zamykające znaczniki i umożliwiają pisanie komentarzy w wielu wierszach. Tagi otwierające i zamykające dla komentarzy blokowych to:

"/ *", aby otworzyć komentarz
"* /" aby zamknąć komentarz

Komentarze blokowe są czasami nazywane wielowierszowymi komentarzami i wyglądają jak wielowierszowe komentarze CSS. Oto przykład komentarza blokowego w JavaScript:

Cały kod między naszymi tagami otwierającymi i zamykającymi zostanie zignorowany przez kompilator.

Każdy rodzaj komentarza może zostać użyty do wyjaśnienia kodu i omówienia intencji stojącej za kod. Oto przykład komentarza wyjaśniającego podstawową deklarację zmiennej:

// Zadeklaruj zmienne „czekoladowe” do przechowywania rodzajów czekolady w postaci tablicy

var chocolate = [` Dark ` „Mleko”, „Biały”, „Orzechy laskowe”, „Karmelowy”];

Komentarze we wszystkich językach programowania „Ęã”powinny być często aktualizowane wraz ze zmianami w kodzie. Jeśli więc zdecydowaliśmy, że nazwa naszej zmiennej zostanie zmieniona na „czekoladowe_typy”, musimy zaktualizować nasz komentarz, aby upewnić się, że odzwierciedla nową nazwę zmiennej. W rzeczywistości programy stają się większe, często się znacznie zmieniają, więc ważne jest, aby zaktualizować komentarze oraz kod

Komentowanie komentarze do kodu

są często używane do jednego z dwóch celów. pierwszy, jak omówiliśmy w tym artykule, to wyjaśnienie intencji twojego kodu i wyjaśnienie wszelkich niejasności. drugim jest zapobieganie wykonywaniu kodu podczas testowania.

Komentowanie kodu umożliwia przerwanie wykonywania jednej lub więcej linii kodu bez całkowitego usuwania kodu z programu. Komentowanie jest powszechne podczas debugowania, ponieważ możesz wypróbować kilka rozwiązań problemu i zapisać kod na później

Oto przykładowy komentarz komentujący wiersz kodu.

Kiedy uruchomimy nasz program, kompilator uruchomi linię kodu deklarującą zmienną Skomentowaliśmy "smaki" ponieważ zawiera błąd i musimy rozwiązać problem. W tym przypadku zapomnieliśmy umieścić znak równości między nazwą naszej zmiennej ("smaki") a wartością zmiennej (nasz zakres smaków).

Albo rozbij każdą z nich. z dwóch typów komentarzy, które omówiliśmy i zbadaj, w jaki sposób można ich użyć.

komentarze jednowierszowe

komentarze jednowierszowe , zwane również komentarzami wstawianymi, służą do skomentowania części linii kodu lub linii pełnej kodu. Oto przykład jednowierszowego komentarza JavaScript:

W tym komentarzu deklarujemy zmienną "first_type", która przechowuje pierwszą wartość w naszym tabela „czekoladowa” . Następnie dodamy komentarz w wierszu na końcu naszego wiersza, aby wyjaśnić intencję naszego kodu.

Komentarze jednowierszowe są zwykle używane do tworzenia krótkich komentarzy na temat kodu lub do opisania intencji stojącej za konkretny wiersz kodu. Jednak komentarze jednowierszowe nie są jedynym rodzajem komentarza, którego powinieneś używać. Jeśli potrzebujesz wyjaśnić większą funkcję, najlepiej napisać komentarze blokowe

komentarze zbiorcze

komentarze zbiorcze są zapisywane w wielu wierszach i służą do wyjaśnienia znacznej części kodu. Chociaż komentarze jednowierszowe zwykle wyjaśniają wiersz kodu, blok komentarza może wyjaśniać funkcję lub funkcję pliku.

wiele wierszy zaczyna się na początku funkcji lub pliku, w większości Oto przykład komentarza blokowego używanego do wyjaśnienia pętli:

Nasz komentarz blokowy obejmuje t linii re i jest używany do opisania kodu zapisanego w dziesięciu w naszej pętli „for”.

Komentarze blokowe można również znaleźć na początku pliku, aby wyjaśnić przeznaczenie pliku lub zawrzeć informacje o autorze i wersji pliku. Oto przykład fragmentu zawierającego autora pliku i datę utworzenia w JavaScript:

Wniosek

Pisanie komentarzy do kodu pozwala pisać w bardziej czytelnym i łatwiejszym w utrzymaniu kodzie. Możesz używać komentarzy, aby zarówno śledzić swój kod dla siebie w przyszłości, jak i ułatwić innym osobom pracującym z nim zrozumienie jego celu.

W tym samouczku omówiliśmy podstawy komentarzy, a następnie zbadał, jak napisać komentarz JavaScript. Omówiliśmy również dwa główne typy komentarzy — jednowierszowe i wielowierszowe — i pokażemy przykłady każdego rodzaju kodu komentarza w działaniu. Na koniec omówiliśmy różnice między komentarzami a komentarzami do kodu.