Modest Programmer logo
21 sierpnia 2018
Tagi: JavaScript
Dzisiaj krótki wpis na temat komentarzy w języku JavaScript.

Czym jest komentarz? Najprościej mówiąc jest to krótka informacja do napisanego kodu. Tekst zawarty w komentarzu nie jest interpretowany, jest ignorowany przez przeglądarki. Dzięki komentarzom kod może być czytelniejszy lub może wyjaśnić jakąś skomplikowaną część kodu. W tym artykule nie będę pisał dlaczego i kiedy stosować komentarze, bo o tym można napisać osobny bardzo obszerny artykuł. Napiszę tylko krótko, że jeśli chodzi o mnie to staram się pisać komentarze, tylko w takim miejscach, gdzie coś może nie być jasne dla programisty, który będzie przejmował ode mnie kod. Raczej nie używam komentarzy, opisujących co robi każda metoda, staram się tak nazywać funkcje oraz zmienne, aby sama nazwa mówiła za co dana funkcja odpowiada. Tobie również polecam takie podejście.

W języku JavaScript dostępne są dwa rodzaje komentarzy: liniowe i blokowe.

Aby oznaczyć tekst jako komentarz liniowy (przez niektórych nazywany także jako wierszowy) należy poprzedzić daną linię dwoma slashami, wówczas zakomentowany zostanie cały tekst znajdujący się po prawej stronie od umieszczonych symboli:
//komentarz liniowy.
Nic nie stoi na przeszkodzie, aby zakomentować tylko część lini:
var age = 10; //przypisanie zmiennej.
Drugim typem komentarzy jest komentarz blokowo (wieloliniowy). Aby dodać taki komentarz należy umieścić tekst pomiędzy znakami slash i gwiazdka na początku, oraz gwiazdka i slasha na końcu (czyli w odwrotnej kolejności).
/* Długi komentarz.
Wieloliniowy.
Koniec komentarza. */
Komentarz blokowy może również zastosować do zakomentowania tylko części lini:
var age = /* komentarz */ 12; 
Ja najczęściej, aby zakomentować tekst w Visual Studio Code używam skrótu ctrl+c, ctrl+k, a do odkomentowania tekstu ctrl+c, ctrl+u.

To wszystko co chciałem Ci przekazać w tym artykule. Zapraszam do kolejnego artykułu z serii podstawy programowania w języku JavaScript.

Kolejny artykuł - Zmienne w JavaScript.
Autor artykułu:
Kazimierz Szpin
Kazimierz Szpin
Programista. Specjalizuje się w C#, głównie WPF, Windows Forms oraz ASP.NET MVC.
Autor bloga ModestProgrammer.pl
Dodaj komentarz
© Copyright 2018 modestprogrammer.pl. Wszelkie prawa zastrzeżone Design by Kazimierz Szpin