Ohjelman kommentointi
458 528 623
Hyvään ohjelmointitapaan kuuluu ohjelmointikielestä ja -tavasta riippumatta selkeä ja riittävä kommentointi. Tekstimuotoisessa ohjelmoinnissa kommentit kirjoitetaan ohjelman alkuun ja ohjelmarivien joukkoon; graafisessa ohjelmoinnissa (esimerkiksi logiikoiden relekaavio-ohjelmat tai muut CAD-pohjaiset ohjelmointitavat) kommentit kirjoitetaan niille varatuille paikoille.
Kommentit voidaan ajatella omina huomioina ja muistiinpanoina ohjelman toiminnasta. Ne ovat välttämättömiä, jotta ohjelmoija itse muistaisi vielä seuraavana päivänäkin, mitä kunkin ohjelmaosuuden on tarkoitus tehdä ja miten ohjelma sen tekee.
Ohjelmaa kirjoittaessa käsillä oleva asia tuntuu usein itsestään selvältä. Mutta kun asiaan palaa päivän tai vaikkapa viiden vuoden päästä, selvältä tuntunut asiaa joutuu pohtimaan pitkän aikaa, ennen kuin se avautuu uudelleen.
Kommentointi on välttämätön apu myös ylläpidon kannalta, jota saattaakin olla tekemässä joku muu, jolla ei ole mitään käsitystä ohjelmaosien tarkoitusperistä ilman kommentteja.
Kommentit erotetaan suoritettavista Python-käskyistä #-merkillä. Python-tulkki hyppää #-merkin kohdalta seuraavalle riville ja jättää siis loppurivin kommentin huomiotta.
Ohjelman alkuun kirjoitetaan kommentteina tyypillisesti seuraavat asiat:
Esimerkiksi laskinohjelman alussa voisi olla seuraavanlainen esittely:
# laskin.py V-0.1 # Python 3.8.0 # # (c) Timo Heikkinen 2019 # # Komentoriviltä käytettävä # käänteistä puolalaista logiikkaa # (RPL) noudattava nelilaskin.
Kommenttirivi voi olla siis tyhjäkin. Tyhjän kommenttirivin alussa ei välttämättä tarvitse käyttää #-merkkiä, mutta sen avulla saadaan kommenttien välissä olevat tyhjät rivit mukaan muodostettaessa ohjelmistosta automaattisesti dokumentointia.