Komentarai Python yra kodo eilutės, kurias vertėjas ignoruoja vykdydamas programą.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
ml iki oz
>
Komentarai pagerina kodo skaitomumą ir padeda programuotojams labai atidžiai suprasti kodą. Tai taip pat padeda bendradarbiauti su kitais kūrėjais, nes pridėjus komentarų lengviau paaiškinti kodą.
Komentarų tipai Python
Python yra trijų tipų komentarai:
- Viena eilutė Komentarai
- Kelių eilučių komentarai
- Styginiai literalai
- Docstring komentarai
Komentarai Python
Pavyzdyje matyti, kad Python Vykdydamas programą, vertėjas nepaiso komentarų.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Išvestis:
geeksforgeeks>
Kodėl Python naudojami komentarai?
Komentarai buvo neatsiejama programavimo kalbų dalis, o kiekviena kalba turi skirtingus komentarų naudojimo būdus.
Kaip ir bet kuri kita kalba, Python komentarai yra skirti šiems tikslams:
python generuoti uuid
- Pagerinkite kodo skaitomumą
- Kodo paaiškinimas kitiems
- Kodo supratimas, jei išstudijuotas po kurio laiko
- Funkcijos žingsnių ir poreikių dokumentavimas
- Kodo bendrinimas su kitais kūrėjais
- Bendradarbiavimas su keliais žmonėmis.
Komentarų tipai Python
Atraskime skirtingus komentarų tipus, kaip juos naudoti ir kada juos naudoti?
1. Vienos eilutės Komentarai
- Python vienos eilutės komentaras prasideda grotažymės simboliu (#) be tarpų ir tęsiasi iki eilutės pabaigos.
- Jei komentaras viršija vieną eilutę, įdėkite žymą su grotelėmis kitoje eilutėje ir tęskite Python komentarą.
- Python vienos eilutės komentarai pasirodė naudingi pateikiant trumpus kintamųjų, funkcijų deklaracijų ir išraiškų paaiškinimus. Žr. šį kodo fragmentą, rodantį vienos eilutės komentarą:
Pavyzdys:
Python3
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Išvestis
techcodeview.com>
2. Kelių eilučių komentarai
Python nesuteikia galimybės kelių eilučių komentarai . Tačiau yra įvairių būdų, kuriais galime rašyti kelių eilučių komentarus.
a) Kelių eilučių komentarai naudojant kelias grotažymes (#)
Norėdami rašyti kelių eilučių komentarus Python, galime naudoti kelias grotažymes (#). Kiekviena eilutė bus laikoma vienos eilutės komentaru.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Išvestis
Multiline comments>
Taip pat patikrinkite: Įdomus faktas apie Python kelių eilučių komentarus
3. Styginiai literalai
Python ignoruoja styginiai literalai kurie nėra priskirti kintamiesiems, todėl galime naudoti šiuos eilučių literatus kaip Python komentarus .
kaip patikrinti monitoriaus ekrano dydį
a) Vienos eilutės komentarai naudojant eilučių literatūrą
Vykdydami aukščiau pateiktą kodą matome, kad nebus jokios išvesties, todėl naudojame eilutes su trigubos citatos () kaip kelių eilučių komentarai.
Python3
'This will be ignored by Python'> |
>
>
b) Kelių eilučių komentarai naudojant eilučių literalus
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
konvertuoti eilutės datą
>Išvestis
Multiline comments>
4. Dokumentų eilutė
- Python dokumentų eilutė yra eilutės raidės su trigubomis kabutėmis, kurios atsiranda iškart po funkcijos.
- Jis naudojamas susieti dokumentaciją, kuri buvo parašyta su Python moduliais, funkcijomis, klasėmis ir metodais.
- Jis pridedamas tiesiai po funkcijomis, moduliais ar klasėmis, kad apibūdintų, ką jie daro. „Python“ dokumentų eilutė pasiekiama naudojant atributą __doc__.
Pavyzdys:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Išvestis:
Multiplies the value of a and b>
Python komentarų pranašumai
Komentarai paprastai naudojami šiais tikslais:
- Kodo skaitomumas
- Projekto kodo arba metaduomenų paaiškinimas
- Užkirsti kelią kodo vykdymui
- Norėdami įtraukti išteklius
Teisingas būdas rašyti komentarus
Komentarai yra pagrindinis tikslas paaiškinti jūsų kodą. Norėdami geriau suprasti kodą, kūrėjai naudoja sveiką komentarų rašymo praktiką.
Kai kurie patarimai, kuriais galite vadovautis, kad komentarai būtų veiksmingi:
- Komentarai turi būti trumpi ir tikslūs.
- Komentarus naudokite tik tada, kai reikia, neperkraukite savo kodo komentarais.
- Komentaras turi turėti tam tikrą prasmę.
- Venkite rašyti bendrų ar pagrindinių komentarų.
- Rašykite komentarus, kurie yra savaime suprantami.
Aptarėme viską apie Python komentarus, kaip rašyti Python komentarus, komentarų tipus, kokie yra jų pranašumai ir kaip teisingai rašyti komentarus.
Taip pat skaitykite: Kaip rašyti komentarus Python3?