Selles õpetuses õpime näidete abil Pythonis kommentaare looma.
Video: kommentaarid Pythonis
Kommentaarid on kirjeldused, mis aitavad programmeerijatel paremini mõista programmi eesmärki ja funktsionaalsust.
Pythoni tõlk ignoreerib neid täielikult.
Kommentaaride kasutamise eelised
Kommentaaride kasutamine programmides muudab meie koodi arusaadavamaks. See muudab programmi loetavamaks, mis aitab meil meeles pidada, miks teatud koodiplokid kirjutati.
Lisaks sellele saab kommentaare kasutada ka mõne koodi ignoreerimiseks teiste koodiplokkide testimisel. See pakub lihtsat viisi mõne rea täitmise ärahoidmiseks või programmi jaoks kiire pseudokoodi kirjutamiseks.
Üherealised kommentaarid Pythonis
Pythonis kasutame #ühe rea kommentaari kirjutamiseks räsi sümbolit .
Näide 1: Üherealiste kommentaaride kirjutamine
# printing a string print('Hello world')
Väljund
Tere, Maailm
Siin on kommentaar:
# printing a string
Pythoni tõlk ignoreerib seda joont.
Kõike, mis järgneb, #eiratakse. Nii võime ülaltoodud programmi kirjutada ka ühele reale järgmiselt:
print('Hello world') #printing a string
Selle programmi väljund on sama, mis näites 1 . Tõlk ignoreerib kogu teksti pärast seda #.
Mitmerealised kommentaarid Pythonis
Python ei paku mitmerealiste kommentaaride kirjutamiseks eraldi viisi. Sellel teemal pääsemiseks on aga muid võimalusi.
Me võime #iga kommentaarirea alguses kasutada mitut rida.
Näide 2: mitme # kasutamine
# it is a # multiline # comment
Siin käsitletakse kõiki ridu ühe kommentaarina ja neid kõiki ignoreeritakse.
String Literals mitmerealiste kommentaaride jaoks
Isegi kui Pythonis pole ainulaadset viisi mitmerealiste kommentaaride kirjutamiseks, teame, et Pythoni tõlgendaja ignoreerib stringiliite, mida muutujale ei määrata.
Nii võime isegi kirjutada ühe rea kommentaari järgmiselt:
#this is a comment 'this is an unassigned string as a comment '
Siin näeme, et programmi teine rida on string, kuid seda ei määrata ühegi muutuja ega funktsiooni jaoks. Niisiis, tõlk ignoreerib stringi.
Samamoodi saame mitmerealiste kommentaaride kirjutamiseks kasutada mitmerealisi stringe (kolmikjutumärke).
Jutumärgiks võib olla kas 'või ".
Näide 3: String-literaalide kasutamine mitmerealiste kommentaaride kirjutamiseks
''' I am a multiline comment! ''' print("Hello World")
Siin ei määrata mitmerealist stringi ühegi muutuja jaoks, seega tõlgendaja ignoreerib seda. Kuigi see pole tehniliselt mitmerealine kommentaar, saab seda kasutada ühena.
Pythoni käsklused
Kokkuleppe kohaselt on kolmekordsed jutumärgid, mis ilmuvad kohe pärast funktsiooni, meetodit või klassi määratlust, käskudeks (dokumentatsioonistringid).
Dokstringid on seotud objektidega ja neile pääseb juurde __doc__atribuudi abil.
Lisateabe saamiseks külastage Pythoni käske.
Kuidas kirjutada paremaid kommentaare?
- Kommentaaride abil kirjeldage, mida funktsioon teeb, mitte üksikasju selle kohta, kuidas funktsioon seda teeb.
- Püüdke eemaldada võimalikult palju üleliigseid kommentaare. Proovige kirjutada kood, mis seletab ennast, kasutades paremat funktsiooni / muutuja nime valikut.
- Püüdke teha kommentaarid võimalikult lühikesed ja kokkuvõtlikud.
