Kommentit

Ohjelmaan on myös mahdollista lisätä selitystekstiä, joka ei vaikuta mitenkään ohjelman suoritukseen, mutta joka auttaa ohjelmatekstin lukijaa ymmärtämään koodia. Tällaisia selitystekstejä kutsutaan kommenteiksi. Python-ohjelmissa kommentit merkitään #-merkillä. Kun Python-tulkki ohjelmaa lukiessaan kohtaa #-merkin, se jättää ottamatta huomioon kaiken tämän merkin jälkeen tulevan tekstin rivin loppuun asti.

Kommenttien järkevä käyttö helpottaa huomattavasti ohjelmaa lukevaa ihmistä koodin ymmärtämisessä. Tällä on merkitystä erityisesti silloin, kun halutaan myöhemmin muuttaa ohjelmaa – esimerkiksi lisätä siihen uusia ominaisuuksia – tai käyttää aikaisemmin tehtyä ohjelmaa jonkin uuden ohjelman pohjana.

Ohjelman alkuun kannattaa aina lisätä kommentti, joka kertoo, mitä ohjelma tekee, kuka sen on kirjoittanut ja koska ohjelmaa on viimeksi muokattu, esimerkiksi:

# Ohjelma, joka muuttaa kayttajan maileina antaman matkan kilometreiksi.
# Kirjoittanut Maija Meikalainen.
# Viimeksi muutettu 9.1.2016.

def main():
    syote = input("Anna matka maileina: ")
    mailit = float(syote)
    kilometrit = 1.6093 * mailit
    print("Matka on", kilometrit, "km.")


main()

Suuremmissa ohjelmissa kannattaa ohjelman sisälle kirjoittaa kommentteja kunkin funktion merkityksestä. Myös funktioiden sisällä voi kommentoida kohtia, joiden merkitys ei selviä helposti koodia lukemalla.

Kommentteja voi kirjoittaa myös varsinaisen ohjelmarivin loppuun, esimerkiksi

kilometrit = 1.6093 * mailit  #Muuta mailit kilometreiksi kertoimen avulla.

Pythonin tyyliopas http://www.python.org/dev/peps/pep-0008/ kuitenkin neuvoo käyttämään rivin loppuun kirjoitettavia kommentteja hyvin säästeliäästi ja suosimaan omille riveilleen kirjoitettavia kommentteja aina, kun se on järkevää.

Merkillä #-alkavien kommenttien sijaan ohjelmassa olevien kokonaisuuksien kommentoimiseen voi käyttää dokumentointimerkkijonoja, (engl. documentation strings, docstrings). Niitä ei kuitenkaan käsitellä tässä oppimateriaalissa.