Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

C-kielessä voidaan osa koodista merkitä kommentiksi, mikä tarkoittaa että sitä ei oteta käännöksessä huomioon. Tällöin kommentteihin voidaan kirjoittaa mitä tahansa. Kommentteja voi käyttää luonnollisesti koodin kommentoimiseen, eli selittää sanallisesti mitä mikäkin koodin osa tekee. Toinen käyttötapa on tilapäisesti poistaa osa koodista käytöstä, säilyttäen se kuitenkin.

C-kielen kommentit

Kaikki mitä on /* ja */ -merkkien välissä luetaan kommentiksi, myös rivinvaihdot.

Esimerkki kommenteista:

Code Block
int main()
{
    int x=0, y=0;     /* horisontaali ja vertikaalikoordinaatit */
}

Tässä tavassa on huonona puolena, että se ei tue sisäkkäisiä kommentteja.

C++ -kielen kommentit

Uudempi, C++ -kielestä tullut kommentointimerkintä, jota kaikki uusimmat kääntäjät tukevat (C99-standardi). Tässä tavassa kaikki mitä on // merkin oikealla puolella, luetaan kommentiksi. Huom. tällä tavalla ei voi kommentoida kuin yhden rivin kerrallaan.

Code Block

int main()
{
    int x=0, y=0;     // horisontaali ja vertikaalikoordinaatit
}

Tässä tavassa on etuna se että se tukee sisäkkäisiä kommentteja ja se on nopeampi kirjoittaa.

Kommentointitapa

Koodia kommentoitaessa on tärkeätä kommentoida se miksi koodissa on tehty jotain mikä ei selviä siitä katsomalla. Liika kommentointi haittaa luettavuutta, mikä taas sotii kommenttien tarkoitusta vastaan.
Kommenttien on siis tarkoitus selventää, mitä koodi tekee ja miksi.

Esimerkiksi seuraava kommentti on täysin turha:

Code Block

int x++; // korotetaan x:ää yhdellä