Tässä opetusohjelmassa opit JavaScript-kommenteista, miksi sinun pitäisi käyttää niitä ja miten niitä käytetään esimerkkien avulla.
JavaScript-kommentit ovat vihjeitä, jotka ohjelmoija voi lisätä helpottaakseen koodinsa lukemista ja ymmärtämistä. JavaScript-moottorit jättävät ne täysin huomiotta.
Kommentteja voi lisätä koodiin kahdella tavalla:
//- Yhden rivin kommentit/* */-Moniviivaiset kommentit
Yhden rivin kommentit
JavaScriptissä kaikki rivit, jotka alkavat, //ovat yhden rivin kommentteja. Esimerkiksi,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Tässä // printing name on the consoleon kommentti.
Voit myös käyttää yhden rivin kommentteja näin:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Moniriviset kommentit
Javascriptissa mikä tahansa teksti /*ja */on monirivinen kommentti. Esimerkiksi,
/* 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. */
Koska loput lähdekoodista käytetään pelisääntöjen toteuttamiseen, yllä oleva kommentti on hyvä esimerkki, jossa voit käyttää monirivistä kommenttia.
Kommenttien käyttäminen virheenkorjaukseen
Kommentteja voidaan käyttää myös koodin poistamiseen käytöstä estääksesi sen suorittamisen. Esimerkiksi,
console.log("some code"); console.log("Error code); console.log("other code");
Jos saat virheen ohjelman suorituksen aikana, sen sijaan, että poistat virhealtista koodia, voit poistaa kommentit käytöstä suorittamalla sen. tämä voi olla arvokas virheenkorjaustyökalu.
console.log("some code"); // console.log("Error code); console.log("other code");
Pro-vinkki: Muista kommenttien käytön pikakuvake; se voi olla todella hyödyllistä. Useimmille koodieditorille se on Ctrl + /tarkoitettu Windowsille ja Cmd + /Macille.
Tee koodista helpompi ymmärtää
JavaScript-kehittäjänä sinun ei tarvitse vain kirjoittaa koodia, vaan myös joutua muokkaamaan muiden kehittäjien kirjoittamaa koodia.
Jos kirjoitat kommentteja koodiin, sinun on helpompi ymmärtää koodi tulevaisuudessa. Kehittäjiesi on myös helpompi ymmärtää koodi.
Nyrkkisääntönä on, että kommenteilla selität miksi teit jotain sen sijaan, että tekisit jotain, ja olet hyvä.
Huomaa: Kommentit eivät saa korvata tapaa selittää huonosti kirjoitettu koodi englanniksi. Sinun tulee aina kirjoittaa hyvin jäsennelty ja itsestään selittävä koodi. Ja sitten käytä kommentteja.
