Kommenttien Käyttäminen Koodin Dokumentointiin
Joskus saatat joutua estämään tietyn osan koodistasi suorittamasta. Koko koodin poistaminen ei ole kätevää, jos haluat testata erillistä osaa myöhemmin. On olemassa erilaisia tilanteita, joissa saatat joutua väliaikaisesti pysäyttämään toimimattoman koodin osan suorittamisen. Tällaisissa tapauksissa kommentit tulevat avuksi.
Huomautus
Kommentit tarjoavat syntaksin, jolla voit piilottaa osia koodistasi tulkilta tai kääntäjältä. Ne ovat myös arvokkaita koodin dokumentoinnissa muille kehittäjille.
Yhden rivin kommentit
Yhden rivin kommentit estävät koko koodirivin, varmistaen, että niiden ylä- ja alapuolella oleva koodi suoritetaan. Yhden rivin kommenttien syntaksi on yksinkertainen: sinun tulee lisätä //
ennen koodia rivillä, jonka haluat kommentoida:
console.log("Line 1"); // console.log("Line 2"); console.log("Line 3");
Yllä oleva esimerkki osoittaa, että kommentti //
estää toisen koodirivin suorittamisen.
Voimme myös käyttää yksirivisiä kommentteja estämään useita koodirivejä peräkkäin:
console.log("Line 1"); console.log("Line 2"); // console.log("Line 3"); // console.log("Line 4"); console.log("Line 5");
Voimme myös lisätä kommentin rivin loppuun.
console.log("Part 1.1"); console.log("Part 1.2"); console.log("Part 2.1"); // console.log("Part 2.2") console.log("Part 3.1"); console.log("Part 3.2");
Moniriviset kommentit
Kuvittele tilanne, jossa on suuri koodilohko, 299 riviä pitkä. Jokaisen rivin kommentoiminen erikseen olisi aikaa vievää. Tässä moniriviset kommentit ovat käteviä.
Moniriviset kommentit alkavat /*
ja päättyvät */
. Kaikki niiden sisällä oleva koodi on kommentoitu:
console.log("Line 1"); console.log("Line 2"); /* console.log("Line 4"); console.log("Line 5"); console.log("Line 6"); console.log("Line 7"); console.log("Line 8"); console.log("Line 9"); */ console.log("Line 11");
Yllä olevassa esimerkissä näemme, että koodiriviä 3–10 ei ole suoritettu.
Voimme käyttää monirivisiä kommentteja kommentoimaan osan rivistä:
console.log("Part 1", /* "Part 2", */ "Part 3");
/* console.log("Part 1"); */ console.log("Part 2");
1. Miksi kommentteja käytetään koodissa?
2. Kuinka luomme yksirivisen kommentin?
3. Mikä on monirivisen kommentin syntaksi?
4. Jos sinulla on suuri koodilohko ja suljet sen /*
ja */
sisään, mitä tapahtuu suljetulle koodille?
Kiitos palautteestasi!