I denne vejledning lærer du om JavaScript-kommentarer, hvorfor du skal bruge dem, og hvordan du bruger dem ved hjælp af eksempler.
JavaScript-kommentarer er tip, som en programmør kan tilføje for at gøre deres kode lettere at læse og forstå. De ignoreres fuldstændigt af JavaScript-motorer.
Der er to måder at tilføje kommentarer til kode på:
//- Kommentarer til en enkelt linje/* */-Multi-line kommentarer
Kommentarer til en enkelt linje
I JavaScript er enhver linje, der starter med //, en enkelt linjekommentar. For eksempel,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Her // printing name on the consoleer en kommentar.
Du kan også bruge en enkelt linjekommentar som denne:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Flere linjekommentarer
I Javascript er enhver tekst mellem /*og */en kommentar med flere linjer. For eksempel,
/* 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. */
Da resten af kildekoden vil blive brugt til at implementere spillereglerne, er kommentaren ovenfor et godt eksempel, hvor du muligvis bruger en kommentar med flere linjer.
Brug af kommentarer til fejlfinding
Kommentarer kan også bruges til at deaktivere kode for at forhindre, at den udføres. For eksempel,
console.log("some code"); console.log("Error code); console.log("other code");
Hvis du får en fejl, mens du kører programmet, i stedet for at fjerne den fejlberettigede kode, kan du bruge kommentarer til at deaktivere den fra at blive udført; dette kan være et værdifuldt fejlfindingsværktøj.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro Tip: Husk genvejen til brug af kommentarer; det kan være virkelig nyttigt. For de fleste kodeditorer er det Ctrl + /til Windows og Cmd + /Mac.
Gør koden lettere at forstå
Som JavaScript-udvikler vil du ikke kun skrive kode, men det kan også være nødvendigt at ændre kode skrevet af andre udviklere.
Hvis du skriver kommentarer til din kode, bliver det lettere for dig at forstå koden i fremtiden. Det vil også være lettere for dine medudviklere at forstå koden.
Som en generel tommelfingerregel skal du bruge kommentarer til at forklare, hvorfor du gjorde noget snarere end hvordan du gjorde noget, og at du er god.
Bemærk: Kommentarer bør ikke erstatte en måde at forklare dårligt skrevet kode på engelsk på. Du skal altid skrive en velstruktureret og selvforklarende kode. Og brug derefter kommentarer.
