Kommenttien Käyttäminen Koodin Dokumentointiin
Joskus voi olla tarpeen estää tietyn koodin osan suorittaminen. Koko koodin poistaminen ei ole kätevää, jos haluat testata toista osaa myöhemmin. On olemassa useita tilanteita, joissa toimimattoman koodin osan suoritus täytyy keskeyttää tilapäisesti. Näissä tapauksissa kommentit ovat hyödyllisiä.
Huomio
Kommentit tarjoavat syntaksin, jolla voit piilottaa koodin osia tulkki- tai kääntäjäohjelmalta. Ne ovat myös arvokkaita koodin dokumentoinnissa muille kehittäjille.
Yksiriviset kommentit
Yksiriviset kommentit estävät koko rivin koodin suorittamisen, jolloin niiden ylä- ja alapuolella oleva koodi suoritetaan normaalisti. Yksirivisen kommentin syntaksi on yksinkertainen: lisää // sen rivin alkuun, jonka haluat kommentoida:
123console.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 peräkkäisiä koodirivejä:
12345console.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.
123console.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
Tarkastellaan tilannetta, jossa on suuri, 299 rivin koodilohko. Jokaisen rivin kommentointi erikseen olisi aikaa vievää. Tällöin moniriviset kommentit ovat hyödyllisiä.
Moniriviset kommentit alkavat merkillä /* ja päättyvät merkkiin */. Kaikki niiden sisällä oleva koodi kommentoidaan pois:
1234567891011console.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ä koodirivit 3–10 eivät ole suorittuneet.
Voimme käyttää monirivisiä kommentteja kommentoidaksemme osan rivistä:
1console.log("Part 1", /* "Part 2", */ "Part 3");
1/* console.log("Part 1"); */ console.log("Part 2");
1. Miksi kommentteja käytetään koodissa?
2. Kuinka luodaan yksirivinen kommentti?
3. Mikä on monirivisen kommentin syntaksi?
4. Jos sinulla on suuri koodilohko ja ympäröit sen /* ja */ merkeillä, mitä tapahtuu ympäröidylle koodille?
Kiitos palautteestasi!
Kysy tekoälyä
Kysy tekoälyä
Kysy mitä tahansa tai kokeile jotakin ehdotetuista kysymyksistä aloittaaksesi keskustelumme
Awesome!
Completion rate improved to 2.5
Kommenttien Käyttäminen Koodin Dokumentointiin
Pyyhkäise näyttääksesi valikon
Joskus voi olla tarpeen estää tietyn koodin osan suorittaminen. Koko koodin poistaminen ei ole kätevää, jos haluat testata toista osaa myöhemmin. On olemassa useita tilanteita, joissa toimimattoman koodin osan suoritus täytyy keskeyttää tilapäisesti. Näissä tapauksissa kommentit ovat hyödyllisiä.
Huomio
Kommentit tarjoavat syntaksin, jolla voit piilottaa koodin osia tulkki- tai kääntäjäohjelmalta. Ne ovat myös arvokkaita koodin dokumentoinnissa muille kehittäjille.
Yksiriviset kommentit
Yksiriviset kommentit estävät koko rivin koodin suorittamisen, jolloin niiden ylä- ja alapuolella oleva koodi suoritetaan normaalisti. Yksirivisen kommentin syntaksi on yksinkertainen: lisää // sen rivin alkuun, jonka haluat kommentoida:
123console.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 peräkkäisiä koodirivejä:
12345console.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.
123console.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
Tarkastellaan tilannetta, jossa on suuri, 299 rivin koodilohko. Jokaisen rivin kommentointi erikseen olisi aikaa vievää. Tällöin moniriviset kommentit ovat hyödyllisiä.
Moniriviset kommentit alkavat merkillä /* ja päättyvät merkkiin */. Kaikki niiden sisällä oleva koodi kommentoidaan pois:
1234567891011console.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ä koodirivit 3–10 eivät ole suorittuneet.
Voimme käyttää monirivisiä kommentteja kommentoidaksemme osan rivistä:
1console.log("Part 1", /* "Part 2", */ "Part 3");
1/* console.log("Part 1"); */ console.log("Part 2");
1. Miksi kommentteja käytetään koodissa?
2. Kuinka luodaan yksirivinen kommentti?
3. Mikä on monirivisen kommentin syntaksi?
4. Jos sinulla on suuri koodilohko ja ympäröit sen /* ja */ merkeillä, mitä tapahtuu ympäröidylle koodille?
Kiitos palautteestasi!