Jak pisać komentarze w kodzie JavaScript

Komentarze to zauważa, że ​​programista pozostawia w swoim kodzie, aby uczynić go bardziej zrozumiałym. Większość seniorów koncentruje się na pisaniu kodu, który jest wydajny i można go łatwo odczytać i interpretować przez komputery. Jednak tak samo jest, aby kod był łatwy do czytelności dla ludzi (którzy będą również pracować z kodem w przyszłości). Programista musi wiedzieć, jak prawidłowo ustrukturyzować kod, aby uczynić go bardziej zrozumiałym dla ludzi.

Jakie są komentarze?

Komentarze mogą być od jednego wyjaśnienia jednego wiersza po wieloletni opis kodu zapisany w kodzie źródłowym programu. Zazwyczaj są używane do pozostawienia notatek w złożonych częściach kodu źródłowego, aby każdy, kto patrzy na kod w przyszłości, może łatwo zrozumieć cel tego kawałka kodu. Ta praktyka oszczędza czas, ponieważ każdy może łatwo zrozumieć cel kodu bez wysiłku.

Teraz zacznijmy uczyć się, jak prawidłowo tworzyć kod źródłowy JavaScript, pisząc różne typy komentarzy:

Rodzaje komentarzy w JavaScript

JavaScript ma dwa główne rodzaje komentarzy:

• Komentarze jednokierunkowe.
• Komentarze wieloletnie

Komentarze jednokierunkowe: W JavaScript dwa cięcia do przodu (//) są używane do pisania komentarzy jednolodowych:

// Komentarz jednoliniowy

Komentarze w dowolnym języku programowania nie mają wpływu na faktyczny program. Tłumacze/kompilatorzy języków programowania są zaprojektowane w sposób, w jaki ignorują wszystkie komentarze podczas interpretacji/kompilacji programu.

Komentarze mogą mieć własne oddzielne linie; Można je również dodać w linii z innym kodem.

Wbudowane komentarze: Gdy komentarze jednokierunkowe są używane w tym samym wierszu, co kod, są one nazywane komentarzami wbudowanymi:

Niech a = 30; // wbudowany komentarz
Niech b = a + 10; // dodanie 10 w „A” i przypisanie jej do „B”

Komentarze wbudowane są używane do wyjaśnienia dokładnego wiersza kodu, w którym są zapisane; Można je użyć do konkretnego, małego opisu kodu obecnego na tej linii.

Komentarze wieloletnie: W JavaScript komentarze blokowe komentarze wieloletnie są napisane w taki sam sposób, jak są one napisane w CSS z tagami otwierającymi (/*) i zamykaniem (*/):

/* Blok
Komentarz*/

Cały tekst między znacznikami otwierającymi i zamykania jest ignorowany przez tłumaczy.

Komentarze wieloletnie lub komentarze na poziomie blokowym są używane do wyjaśnienia i podania szczegółowego opisu sekcji kodu. Ten typ komentarzy jest zwykle umieszczany u góry pliku kodu źródłowego lub przed szczególnie złożonym blokiem kodu:

/* Pobieranie nazwy użytkownika
z pola wejściowego
i pokazanie go na konsoli */
funkcja showuser ()
Nazwa const = dokument.getElementById („nazwa użytkownika”);
konsola.Log („Witam i witam w Linuxhint.com, „ + nazwa +”.");

sesja ();

Komentowanie kodu testowania/debugowania: Komentarze można wykorzystać do szybkiego i łatwego zapobiegania wykonaniu kodu blokowego; Tak wielu starszych deweloperów JavaScript używa również komentarzy do testowania i debugowania. Umieszczenie znaczników komentarzy za blokiem kodu, aby był on ignorowany przez interpretera i nie jest wykonywany, jest określane jako „komentowanie kodu”.

Komentowanie kodu pomaga wskazać przyczynę błędu w kodzie. Można je również użyć do testowania różnych bloków kodu, aby uzyskać różne wyniki:

// funkcja dzielenia dwóch liczb
Wydział funkcji (Dividend, Divisor)
niech iloraz = dywidenda / dzielnik;
iloraz zwrotu;

// funkcja odejmowania dwóch liczb
Odejmowanie funkcji (NUM1, NUM2)
niech sub = num1 - num2;
zwrot;

/* W poniższym wierszu kodu komentujemy wywołanie funkcji funkcji podziału. Dlatego tylko funkcja subtraction () zostanie wywołana i wykonana. */
// Division (30, 5);
multiplytWonumbers (9, 3);

Praktyki pisania dobrego kodu JavaScript

Tutaj omówimy trzy najlepsze praktyki pisania dobrego kodu JavaScript:

Komentarze są ogólnie napisane powyżej bloku kodu, który wyjaśniają:

// show "Hello, Linuxhint!„Na konsoli
konsola.Log („Cześć, Linuxhint!");

Komentarze wcięcia na tym samym poziomie co kod bezpośrednio pod nimi:

// Definicja funkcji
funkcja showuser ()
// Pobieranie nazwy użytkownika
Nazwa const = dokument.getElementById („nazwa użytkownika”);
// Wydrukuj wiadomość na konsoli
konsola.Log („Witam i witam w Linuxhint.com, „ + nazwa +”.");

Pamiętaj, że nie ma możliwości zakończenia wbudowanych komentarzy; Dlatego powinny być napisane dopiero po tym, jak kod tego wiersza został całkowicie napisany:

dla (niech i = 0; i === 10; i ++) // dla pętli, która działa dziesięć razy
// Uruchomienie tego kodu powoduje błąd składni

Wniosek

Ile razy rozwiązałeś złożony problem, pisząc jakiś kod tylko po to, aby wrócić kilka miesięcy później i dowiedzieć się, że nic nie pamiętasz i nic nie rozumiesz? Komentarze pomagają uniknąć tego, pisząc szczegółowe wyjaśnienia/opisy kodu. Pomagają również w debugowaniu testowania i wskazywaniu źródła błędów w twoim kodzie. Zarówno komentarze pojedyncze, jak i wielopoziomowe mogą być używane do celów debugowania/testowania. Jeśli jesteś początkującym programem JavaScript, powinieneś napisać jak najwięcej komentarzy w swoim kodzie, ponieważ są one niezbędne do zrozumienia piszesz kodu; ale pamiętaj, że należy je dodać tylko tam, gdzie są potrzebne.