Kommentaarid

Kõikide programmikeste näidetes va arvu arvamise mängus olid meil vaid käsud arvuti jaoks. Kuid väga kasulik on kohe alguses õppida kirjutama koodi sisse kommentaare ka iseenda või teiste jaoks, kes sinu koodi loevad. Vaata näiteks arvu arvamise mängu koodi. Seal on mitmeid punaseid ridu, mis ei tähenda arvuti jaoks mitte midagi, kuid inimese jaoks, kes seda koodi loeb, võivad saada paljud asjad märksa selgemaks ja arusaadavamaks.

Lisaks selgusele on kommentaaridel väga oluline roll ka programmi dokumenteerimisel. Mida see tähendab? Dokumentatsioon on midagi kasutusjuhendi taolist ja vastab tüüpiliselt umbes sellistele küsimusetele:

• Milleks on antud programm kirjutatud?
• Kes on selle programmi kirjutanud?
• Kellele on see programm kasutamiseks mõeldud?
• Kuidas on programmi töö organiseeritud?
• Ja nii edasi ...

Kuidas lisada kommentaare?

Kommenteerida saab mitmel erineval moel.

Üherealine kommentaar

Iga rea võib muuta kommentaariks, kui panna rea algusesse trellide (#) märk. Märgi taga olev tekst muutub IDLE-s punaseks ja on automaatselt sellega Pythonile selgeks teinud, et seda rida ei pea programmi käivitamisel vaatama.

Üherealisi kommenteerimisi kasutatakse ka näiteks mõne päris koodirea välja jätmiseks olukorras, kus programm ei tee päris seda mida ta võiks teha. Nii erinevaid ridu välja kommenteerides on üks võimalus veale jälile jõuda.

Mitmerealine kommentaar

Kui on vaja kirjutada veidi pikemat selgitust mõne programmilõigu kohta, siis tasub kasutada mitmerealist kommenteerimise stiili. Mitmerealise kommentaari saad sa kas iga rea ette trellide panemisega või kasutada kolmekordseid jutumärke.

Trellidega mitmerealise kommentaari lisamisel kasutatakse tihti tärnidega kombineeritud varianti, see toob kommentaari väga selgelt muust koodist esile ja on kergesti üles leitav ja loetav. Sellist stiili kasutatakse tihti programmi alguses, kuhu kirjutatakse programmi tegija nimi/nimed, kuupäevad, kellele ja milleks on programm loodud jne.