I den här handledningen lär du dig JavaScript-kommentarer, varför du ska använda dem och hur du använder dem med hjälp av exempel.
JavaScript-kommentarer är tips som en programmerare kan lägga till för att göra sin kod lättare att läsa och förstå. De ignoreras helt av JavaScript-motorer.
Det finns två sätt att lägga till kommentarer till koden:
//- Kommentarer från en rad/* */-Multi-line kommentarer
Kommentarer från en rad
I JavaScript är alla rader som börjar med //en enstaka radkommentar. Till exempel,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Här // printing name on the consoleär en kommentar.
Du kan också använda enstaka radkommentarer så här:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Flerlinjekommentarer
I Javascript är all text mellan /*och */en kommentar med flera rader. Till exempel,
/* 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. */
Eftersom resten av källkoden kommer att användas för att implementera spelets regler är kommentaren ovan ett bra exempel där du kan använda en kommentar med flera rader.
Använda kommentarer för felsökning
Kommentarer kan också användas för att inaktivera kod för att förhindra att den körs. Till exempel,
console.log("some code"); console.log("Error code); console.log("other code");
Om du får ett fel när du kör programmet, istället för att ta bort den felbenägna koden, kan du använda kommentarer för att inaktivera att den körs; detta kan vara ett värdefullt felsökningsverktyg.
console.log("some code"); // console.log("Error code); console.log("other code");
Proffstips: Kom ihåg genvägen för att använda kommentarer; det kan vara riktigt bra. För de flesta kodredigerare är det Ctrl + /för Windows och Cmd + /Mac.
Gör koden lättare att förstå
Som JavaScript-utvecklare skriver du inte bara kod utan kan också behöva ändra kod skriven av andra utvecklare.
Om du skriver kommentarer till din kod blir det lättare för dig att förstå koden i framtiden. Det blir också lättare för dina andra utvecklare att förstå koden.
Som en allmän tumregel, använd kommentarer för att förklara varför du gjorde något snarare än hur du gjorde något, och att du är bra.
Obs! Kommentarer bör inte ersätta ett sätt att förklara dåligt skriven kod på engelska. Du bör alltid skriva välstrukturerad och självförklarande kod. Och använd sedan kommentarer.
