wiki:Kommentointi
Last modified 9 years ago Last modified on 2010-07-13 15:44:26

Apuja ohjelmointiin » Ohjelmakoodin kommentointi

Kommentit kuvaavat jonkin ohjelman osan toimintaa ohjelmakoodin lukijalle. Kommentit eivät varsinaisesti "tee mitään", eikä niitä lisätä mukaan valmiiseen ohjelmaan, mutta ovat silti tarpeellisia varsinkin pidemmissä ohjelmissa.

Rivikommentti

Rivikommentti alkaa kahdella kauttaviivalla, ja kommentoi kaiken siitä eteenpäin rivin loppuun. Kommentoinnilla tarkoitetaan, ettei sitä osaa lasketa suoritettavaksi ohjelmakoodiksi.

// Rivin aloittaminen kahdella kauttaviivalla kommentoi koko rivin
nakki = 3;   // Kommentin ei tarvitse olla rivin alussa. Huomaa, että "nakki = 3;" suoritetaan normaalisti.

Lohkokommentti

Pidemmille kommenteille voi käyttää ns. lohkokommenttia, joka kommentoi kaiken kommentin aloituksen /* ja lopetuksen */ välistä.

   Tämä ei ole kommentti.
/*
   Tämä on kommentti.
   Tämäkin on kommentti.
*/
   Tämä ei ole kommentti.

Milloin kommentoida?

Hyvä periaate on kommentoida kaikki, mitä itse ohjelmakoodista ei heti näe. Turhia ja harhaanjohtavia kommentteja on syytä välttää.

Esimerkki hyvästä kommentista:

// Lasketaan keskiarvo luvuille a, b ja c
x = ( a + b + c ) / 3;

Esimerkki tarpeettomasta kommentista:

// Kutsutaan metodia ammu
ammu();