W tym samouczku dowiesz się o komentarzach JavaScript, dlaczego warto ich używać i jak z nich korzystać, korzystając z przykładów.
Komentarze JavaScript to wskazówki, które programista może dodać, aby ich kod był łatwiejszy do odczytania i zrozumienia. Są całkowicie ignorowane przez silniki JavaScript.
Istnieją dwa sposoby dodawania komentarzy do kodu:
//- Komentarze jednowierszowe/* */-Wielowierszowe komentarze
Komentarze jednowierszowe
W JavaScript każda linia zaczynająca się od //jest komentarzem jednowierszowym. Na przykład,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Tutaj // printing name on the consolejest komentarz.
Możesz również użyć komentarza jednowierszowego w następujący sposób:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Komentarze wielowierszowe
W Javascript dowolny tekst pomiędzy /*i */jest komentarzem wielowierszowym. Na przykład,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Ponieważ reszta kodu źródłowego zostanie wykorzystana do implementacji reguł gry, powyższy komentarz jest dobrym przykładem, w którym możesz użyć komentarza wielowierszowego.
Używanie komentarzy do debugowania
Komentarze mogą również służyć do wyłączania kodu, aby uniemożliwić jego wykonanie. Na przykład,
console.log("some code"); console.log("Error code); console.log("other code");
Jeśli podczas uruchamiania programu pojawi się błąd, zamiast usuwać podatny na błędy kod, możesz użyć komentarzy, aby wyłączyć jego wykonywanie; może to być cenne narzędzie do debugowania.
console.log("some code"); // console.log("Error code); console.log("other code");
Wskazówka dla profesjonalistów: Zapamiętaj skrót do używania komentarzy; to może być naprawdę pomocne. W przypadku większości edytorów kodu jest to Ctrl + /system Windows i Cmd + /Mac.
Uczyń kod łatwiejszym do zrozumienia
Jako programista JavaScript nie tylko będziesz pisać kod, ale być może będziesz musiał modyfikować kod napisany przez innych programistów.
Jeśli napiszesz komentarze do swojego kodu, łatwiej będzie ci go zrozumieć w przyszłości. Innym programistom będzie też łatwiej zrozumieć kod.
Ogólnie rzecz biorąc, używaj komentarzy, aby wyjaśnić, dlaczego coś zrobiłeś, a nie jak coś zrobiłeś, i jesteś dobry.
Uwaga: Komentarze nie powinny zastępować sposobu na wyjaśnienie źle napisanego kodu w języku angielskim. Zawsze powinieneś pisać dobrze zorganizowany i zrozumiały kod. A następnie użyj komentarzy.
