Komentarji v Pythonu so vrstice v kodi, ki jih tolmač med izvajanjem programa prezre.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Komentarji povečajo berljivost kode in pomagajo programerjem, da zelo natančno razumejo kodo. Pomaga tudi pri sodelovanju z drugimi razvijalci, saj dodajanje komentarjev olajša razlago kode.
Vrste komentarjev v Pythonu
V Pythonu obstajajo tri vrste komentarjev:
- Enovrstični komentarji
- Večvrstični komentarji
- Nizovni literali
- Komentarji Docstring
Komentarji v Pythonu
Na primeru je razvidno, da Python Tolmač med izvajanjem programa ignorira komentarje.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Izhod:
geeksforgeeks>
Zakaj se komentarji uporabljajo v Pythonu?
Komentarji so bili sestavni del programskih jezikov in vsak jezik ima različne načine uporabe komentarjev.
Tako kot v katerem koli drugem jeziku tudi komentarji v Pythonu služijo naslednjemu namenu:
- Izboljšajte berljivost kode
- Razlaga kode drugim
- Razumevanje kode, če jo preučimo čez nekaj časa
- Dokumentiranje korakov in potreb za funkcijo
- Skupna raba kode s kolegi razvijalci
- Sodelovanje z več ljudmi.
Vrste komentarjev v Pythonu
Odkrijmo različne vrste komentarjev, kako jih uporabiti in kdaj jih uporabiti?
1. Enovrstični Komentarji
- Python enovrstični komentar se začne s simbolom hashtag (#) brez presledkov in traja do konca vrstice.
- Če komentar presega eno vrstico, vstavite hashtag v naslednjo vrstico in nadaljujte s komentarjem Python.
- Enovrstični komentarji Pythona so se izkazali za uporabne za zagotavljanje kratkih razlag za spremenljivke, deklaracije funkcij in izraze. Oglejte si naslednji delček kode, ki prikazuje enovrstični komentar:
primer:
Python3
poimenovanje v Javi
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Izhod
techcodeview.com>
2. Večvrstični komentarji
Python ne ponuja možnosti za večvrstični komentarji . Vendar pa obstajajo različni načini, s katerimi lahko pišemo večvrstične komentarje.
a) Večvrstični komentarji z uporabo več hashtagov (#)
Za pisanje večvrstičnih komentarjev v Pythonu lahko uporabimo več hashtagov (#). Vsaka vrstica bo obravnavana kot enovrstični komentar.
Python3
java logični niz
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Izhod
Multiline comments>
Preverite tudi: Zanimivo dejstvo o večvrstičnih komentarjih Python
3. Nizovni literali
Python ignorira nizovni literali ki niso dodeljeni spremenljivki, tako da lahko te nizovne literale uporabimo kot komentarje Python .
a) Enovrstični komentarji z nizovnimi literali
Pri izvajanju zgornje kode lahko vidimo, da ne bo nobenega izhoda, zato uporabimo nize z trojni narekovaji () kot večvrstični komentarji.
Python3
'This will be ignored by Python'> |
>
>
b) Večvrstični komentarji z nizovnimi literali
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Izhod
Multiline comments>
4. Docstring
- Python dokumentni niz je nizovni literal s trojnimi narekovaji, ki se pojavi takoj za funkcijo.
- Uporablja se za povezovanje dokumentacije, ki je bila napisana z moduli, funkcijami, razredi in metodami Python.
- Doda se tik pod funkcijami, moduli ali razredi, da opiše, kaj počnejo. V Pythonu je dokumentni niz nato na voljo prek atributa __doc__.
primer:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
niz v polje java
>
Izhod:
Multiplies the value of a and b>
Prednosti komentarjev v Pythonu
Komentarji se običajno uporabljajo za naslednje namene:
- Berljivost kode
- Razlaga kode ali metapodatkov projekta
- Prepreči izvajanje kode
- Za vključitev virov
Pravi način za pisanje komentarjev
Glavni namen komentarjev je pojasniti vašo kodo. Razvijalci uporabljajo zdravo prakso pisanja komentarjev za boljše razumevanje kode.
Nekateri nasveti, ki jih lahko upoštevate, da bodo vaši komentarji učinkoviti, so:
- Komentarji naj bodo kratki in natančni.
- Komentarje uporabljajte samo, kadar je to potrebno, kode ne natrpajte s komentarji.
- Komentar mora imeti nek pomen.
- Izogibajte se pisanju splošnih ali osnovnih komentarjev.
- Napišite komentarje, ki so samoumevni.
Razpravljali smo o komentarjih v Pythonu, o tem, kako napisati komentarje v Pythonu, o vrstah komentarjev, o njegovih prednostih in pravilnem načinu za pisanje komentarjev.
Preberite tudi: Kako napisati komentarje v Python3?