2. Kommentaarid
Oleme kindlasti juba kogenud, et veidigi pikemate programmide puhul on muutujatele nimede valimine väga tähtis: meil on hea ülevaade, mida üks või teine muutuja endas sisaldab. Ilmselt mäletame ka oma lahenduskäike. Sageli peame aga oma koodi lugema palju aega hiljem või peab sellest aru saama ka keegi teine. Seepärast on kohustuslik lisada koodile kommentaare. Kommentaarid on tekstid, mida Python ei täida, need on mõeldud inimesele lugemiseks ning mida lihtsalt näidatakse programmiridade vahel.
Kommentaaridena lisatakse programmi algusesse ka programmi nimi, autori nimi jm programmi iseloomustavad andmed.
Kommentaarid algavad märgiga # (trellid), samal real sellele märgile järgnevat teksti programmi täitmisel ignoreeritakse.
# Kahe sisestatud arvu liitmine ja tulemuse väljastamine print(arv1 + arv2)
Eelmisega samaväärne oleks ka järgnev koodilõik.
print(arv1 + arv2) # Kahe sisestatud arvu liitmine ja tulemuse väljastamine
Samasugust kommenteerimist on kasutatud selles õppematerjalis ka näidete puhul.
Kommentaaridena on asjakohane esitada programmi alguses ka muud metainfot: programmi pealkiri, autori nimi, kuupäev jne, et tulevikus oleks lihtsam programme leida. Näiteks nii:
# ============================================= # Tervitamine koos nime küsimisega # Autor: Mari Maasikas # Kuupäev: 26. oktoober 2014 # ============================================= # Programm küsib kasutajalt nime ja väljastab # seejärel nimelise tervituse # =============================================
Creative Commons litsentsiga Autorile viitamine + Mitteäriline eesmärk 3.0 Eesti (CC BY-NC 3.0 EE) - https://creativecommons.org/licenses/by-nc/3.0/ee/
