U ovom uputstvu naučit ćemo stvarati komentare u Pythonu uz pomoć primjera.
Video: Komentari na Pythonu
Komentari su opisi koji pomažu programerima da bolje razumiju namjeru i funkcionalnost programa.
U potpunosti ih ignorira Python tumač.
Prednosti korištenja komentara
Korištenje komentara u programima čini naš kod razumljivijim. Program čini čitljivijim što nam pomaže da se sjetimo zašto su napisani određeni blokovi koda.
Osim toga, komentari se također mogu koristiti za ignoriranje nekog koda tijekom testiranja drugih blokova koda. Ovo nudi jednostavan način da se spriječi izvršavanje nekih redaka ili napiše brzi pseudo-kôd za program.
Jednoredni komentari na Pythonu
U Pythonu koristimo simbol hash #za pisanje komentara u jednom retku.
Primjer 1: Pisanje jednorednih komentara
# printing a string print('Hello world')
Izlaz
Pozdrav svijete
Evo, komentar je:
# printing a string
Ovaj redak ignorira Python tumač.
Sve što dolazi nakon toga #se zanemaruje. Dakle, gornji program također možemo napisati u jedan redak kao:
print('Hello world') #printing a string
Rezultat ovog programa bit će isti kao u primjeru 1 . Tumač ignorira sav tekst nakon #.
Višeredni komentari u Pythonu
Python ne nudi zaseban način pisanja višerednih komentara. Međutim, postoje i drugi načini za zaobilaženje ovog problema.
#Na početku svakog retka komentara možemo koristiti više redaka.
Primjer 2: Korištenje višestrukih #
# it is a # multiline # comment
Ovdje se svaki redak tretira kao jedan komentar i svi se oni zanemaruju.
String Literals za višeredne komentare
Iako ne postoji jedinstveni način pisanja višerednih komentara u Pythonu, znamo da Python interpreter ignorira niz literala koji nisu dodijeljeni varijabli.
Dakle, čak možemo napisati jednoredni komentar kao:
#this is a comment 'this is an unassigned string as a comment '
Ovdje možemo vidjeti da je drugi redak programa niz, ali nije dodijeljen nijednoj varijabli ili funkciji. Dakle, tumač ignorira niz.
Na sličan način možemo koristiti višeredne nizove (trostruki navodnici) za pisanje višerednih komentara.
Navodni znak može biti 'ili ".
Primjer 3: Korištenje String Literala za pisanje višerednih komentara
''' I am a multiline comment! ''' print("Hello World")
Ovdje višeredni niz nije dodijeljen nijednoj varijabli, pa ga tumač ignorira. Iako tehnički nije viševrstični komentar, može se koristiti kao jedan.
Python docstrings
Prema dogovoru, trostruki navodnici koji se pojavljuju odmah nakon definicije funkcije, metode ili klase su docstrings (nizovi dokumentacije).
Docstrings su povezani s objektima i može im se pristupiti pomoću __doc__atributa.
Da biste saznali više, posjetite Python docstrings.
Kako napisati bolje komentare?
- Koristite komentare da biste opisali što funkcija radi, a ne određene pojedinosti o tome kako to funkcija radi.
- Pokušajte ukloniti što više suvišnih komentara. Pokušajte napisati kôd koji se može objasniti, koristeći bolji izbor funkcije / varijable.
- Pokušajte da komentari budu što kraći i sažetiji.
