Komentāri Python ir koda rindas, kuras programmas izpildes laikā tulks ignorē.
kurš izgudroja skolu
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Komentāri uzlabo koda lasāmību un palīdz programmētājiem ļoti rūpīgi saprast kodu. Tas palīdz arī sadarboties ar citiem izstrādātājiem, jo komentāru pievienošana atvieglo koda izskaidrošanu.
Python komentāru veidi
Python ir trīs veidu komentāri:
- Viena rinda Komentāri
- Daudzrindu komentāri
- Stīgu burti
- Docstring komentāri
Komentāri Python
Piemērā var redzēt, ka Python Programmas izpildes laikā tulks komentārus ignorē.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Izvade:
geeksforgeeks>
Kāpēc Python tiek izmantoti komentāri?
Komentāri ir bijusi neatņemama programmēšanas valodu sastāvdaļa, un katrai valodai ir atšķirīgi komentāru izmantošanas veidi.
iegūt pašreizējo datumu java
Tāpat kā jebkurā citā valodā, Python komentāriem ir šāds mērķis:
- Uzlabojiet koda lasāmību
- Koda izskaidrošana citiem
- Koda izpratne, ja pēc kāda laika tiek pētīta
- Funkcijas darbību un vajadzību dokumentēšana
- Koda koplietošana ar citiem izstrādātājiem
- Sadarbība ar vairākiem cilvēkiem.
Python komentāru veidi
Atklāsim dažādus komentāru veidus, kā tos izmantot un kad tos izmantot?
1. Single-line komentāri
- Python vienas rindiņas komentārs sākas ar atsauces simbolu (#) bez atstarpēm un ilgst līdz rindas beigām.
- Ja komentārs pārsniedz vienu rindiņu, nākamajā rindā ievietojiet hashtag un turpiniet Python komentāru.
- Python vienas rindiņas komentāri ir izrādījušies noderīgi, lai sniegtu īsus skaidrojumus mainīgajiem, funkciju deklarācijām un izteiksmēm. Skatiet šo koda fragmentu, kas parāda vienas rindiņas komentāru:
Piemērs:
Python3
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Izvade
techcodeview.com>
2. Vairāku rindu komentāri
Python nenodrošina iespēju vairāku rindiņu komentāri . Tomēr ir dažādi veidi, kā mēs varam rakstīt vairāku rindiņu komentārus.
a) Vairāku rindiņu komentāri, izmantojot vairākas atsauces (#)
Mēs varam izmantot vairākus atsauces tagus (#), lai Python rakstītu vairāku rindiņu komentārus. Katra rinda tiks uzskatīta par vienas rindiņas komentāru.
kurš ir Fredijs Merkūrijs
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Izvade
Multiline comments>
Pārbaudiet arī: Interesants fakts par Python daudzrindu komentāriem
3. Stīgu burti
Python ignorē stīgu literāļi kas nav piešķirti mainīgajam, lai mēs varētu izmantot šos virknes literāļus kā Python komentārus .
a) Vienas rindiņas komentāri, izmantojot virknes literāļus
Izpildot iepriekš minēto kodu, mēs redzam, ka nebūs nekādas izvades, tāpēc mēs izmantojam virknes ar trīskārši pēdiņas () kā daudzrindu komentāri.
Python3
'This will be ignored by Python'> |
>
>
b) Daudzrindu komentāri, izmantojot virknes literāļus
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
bash cits, ja
>
>Izvade
Multiline comments>
4. Docstring
- Python dokumentu virkne ir virknes literāļi ar trīskāršām pēdiņām, kas parādās uzreiz aiz funkcijas.
- To izmanto, lai saistītu dokumentāciju, kas ir rakstīta ar Python moduļiem, funkcijām, klasēm un metodēm.
- Tas tiek pievienots tieši zem funkcijām, moduļiem vai klasēm, lai aprakstītu to darbību. Programmā Python dokumentācijas virkne pēc tam tiek padarīta pieejama, izmantojot atribūtu __doc__.
Piemērs:
Python3
aktieris ranbir kapoor vecums
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Izvade:
Multiplies the value of a and b>
Python komentāru priekšrocības
Komentāri parasti tiek izmantoti šādiem mērķiem:
- Koda lasāmība
- Projekta koda vai metadatu skaidrojums
- Novērst koda izpildi
- Lai iekļautu resursus
Pareizs veids, kā rakstīt komentārus
Komentāri ir galvenais mērķis, lai izskaidrotu jūsu kodu. Izstrādātāji izmanto veselīgu komentāru rakstīšanas praksi, lai labāk izprastu kodu.
Daži padomi, ko varat ievērot, lai komentāri būtu efektīvi, ir šādi:
- Komentāriem jābūt īsiem un precīziem.
- Izmantojiet komentārus tikai nepieciešamības gadījumā, nepārblīvējiet savu kodu ar komentāriem.
- Komentāram ir jābūt kādai nozīmei.
- Izvairieties rakstīt vispārīgus vai pamata komentārus.
- Rakstiet komentārus, kas ir pašsaprotami.
Mēs esam pārrunājuši visu par Python komentāriem, kā rakstīt Python komentārus, komentāru veidiem, kādas ir tā priekšrocības un pareizo veidu komentāru rakstīšanai.
Lasi arī: Kā rakstīt komentārus programmā Python3?