Koodin kommentointi

    “Code is more often read than written.”  
    — Guido van Rossum

Kommentit

Kommentit eivät vaikuta ohjelman suorittamiseen. Kommentit tehdään meitä ihmisiä varten koodin dokumentoimiseksi. Kääntäjä ei huomioi kommentteja käännösvaiheessa, vaan jättää ne pois käännöksestä.

Kommentointi kuuluu ohjelmointiin erittäin tärkeänä osana. Kommentoinnin tarkoitus on parantaa koodin luettavuutta ja antaa lisätietoa koodin toiminnasta. Kommentointi helpottaa sovelluksen ylläpitoa ja jatkokehitystä. Valitettavan usein ohjelmoijat jättävät kommentoinnin tekemättä tai ainakin tekevät sen puutteellisesti.

Kommentointi voidaan toteuttaa muutamalla eri tavalla:

1) tavallisin tapa, aloita rivi #-merkillä (engl. hashtag), kutsutaan myös nimellä risuaita

# starts comment it this line

2) useamman rivin kommentti: kolme lainausmerkkiä

'''
   multiple lines comment
   can continue here
   and here...
'''

Vaikka hyvä koodi kommentoi itse itseään, niin kommentoimaton ohjelma ei ole merkki ohjelmoijan asiantuntevuudesta, vaan laiskuudesta!

Kommentit erotetaan koodista

Eri sovelluskehittimet ja tekstieditorit erottavat kommentit varsinaisista suoritettavista ohjelmariveistä eri väreillä. Oletusarvoisesti IDLE esittää kommenttirivit punaisella värillä.

Oletusarvoisesti Visual Studio Code esittää kommenttirivit vihreällä värillä.

Dokumenttikomentti

Ohjelmoinnin kasvaessa ja varsinkin silloin kun aletaan tehdä omia luokkia, käyttöön tulee myös dokumenttikomentti. Tiettyä syntaksia noudattamalla voidaan dokumenttikommentit muuttaa sellaiseen muotoon, että niitä voidaan tarkastella esimerkiksi nettiselaimella. Dokumenttikommentti on syytä kirjoittaa ainakin ennen jokaista luokkaa, pääohjelmaa ja toimintoa ennen. Lisäksi jokainen tiedosto voisi alkaa dokumenttikommentilla, josta selviää tiedoston tarkoitus, tekijä, versio ja esim. päivämäärä.