V tem članku se bomo poglobili v koncept večvrstičnih komentarjev v Pythonu in zagotovili izčrpno definicijo skupaj z ilustrativnimi primeri v programskem jeziku Python o tem, kako komentirati več vrstic v Python .
Kaj je večvrstični komentar v Pythonu?
Večvrstični komentarji v Pythonu se nanašajo na blok besedila ali stavkov, ki se uporabljajo za razlago ali dokumentacijo znotraj kode. V nasprotju z enovrstičnimi komentarji, označenimi s simbolom zrezka (#), so večvrstični komentarji obdani s trojnimi dvojnimi narekovaji (``) ali trojnimi enojnimi narekovaji (`’`). Ti komentarji se pogosto uporabljajo za zagotavljanje podrobnih razlag, dokumentacije ali opomb o kodi in lahko zajemajo več vrstic. Čeprav Python nima posebne sintakse za večvrstične komentarje, uporaba trojnih narekovajev doseže podoben učinek, saj tolmač ignorira priloženo besedilo.
Vrste večvrstičnih komentarjev v Pythonu
Večvrstične komentarje Python lahko v kodo dodamo na dva načina. So naslednji:
nizovne metode java
- Zaporedni enovrstični komentar
- Uporaba večvrstičnega niza kot komentarja
- Uporaba metode poševnice nazaj
Komentirajte več vrstic v Pythonu z uporabo zaporednega enovrstičnega komentarja
noter Python , se za komentiranje vrstice uporablja dišavni znak (#). Enovrstični komentarji v Pythonu ni nujno, da je samo besedilo za razlago kode, lahko pa se uporabijo tudi za preprečitev Pythonu izvajanja kode. Znak za zgoščevanje je treba postaviti pred vsako vrstico, da se v Pythonu obravnava kot večvrstični komentar.
Primer: zaporedni enovrstični komentar
Tukaj prvi dve vrstici vsebujeta zgoščevalnik (#) in tolmač prepreči izvajanje obeh vrstic. Nato natisne komentarje Python in končno prepreči izvedbo zadnje vrstice.
Python3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')> Izhod:
Python Comments>
Komentirajte več vrstic v Pythonu z uporabo večvrstičnega niza kot komentarja
Večvrstični komentarji Python so lahko tudi zaprti v ločilo (). Tudi med ločili () ne sme biti praznega prostora. Uporabni so, ko se besedilo komentarja ne prilega eni vrstici, zato se mora raztezati čez vrstice. Ta vrsta nizovnega literala se prezre, ker ni dodeljena nobeni spremenljivki. Do teh nizov lahko dostopamo z __doc__.
string.compareto c#
Primer: uporaba večvrstičnega niza kot komentarja
Večvrstični komentarji se uporabljajo za komentiranje več kot ene vrstice. Prva vrstica je enovrstični komentar. Drugo in tretjo vrstico lahko komentirate s trojnimi narekovaji ( ). To prepreči izvajanje zgornje kode. Končno natisne matematiko v izhodu. Vendar, če so ti večvrstični komentarji Python postavljeni neposredno za podpisom funkcije ali razreda, potem se spremenijo v nizi dokumentov .
Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')> Izhod:
Mathematics>
Komentirajte več vrstic v Pythonu z metodo Backslash
Metoda za ustvarjanje večvrstičnih komentarjev v Pythonu vključuje uporabo poševnice nazaj (``) na koncu vsake vrstice, da se uporabi funkcija nadaljevanja vrstice, s čimer se komentar razširi na naslednjo vrstico. Ta metoda nadaljevanja vrstice je manj pogosta kot drugi pristopi, kot so zaporedni enovrstični komentarji ali večvrstični nizi, in se uporablja predvsem za namene berljivosti kode, ko je treba komentar prekiniti v več vrsticah.
nginx
Primer : V tem primeru so komentarji, ki se začnejo z#>se razširijo na več vrstic z uporabo poševnice nazaj (>) na koncu vsake vrstice. Poševnica nazaj označuje, da se komentar nadaljuje v naslednji vrstici. Ta metoda je lahko koristna za izboljšanje berljivosti kode, ko imate dolge komentarje.
# Using backslash for multiline comments # This is a long comment # that spans multiple lines # using the backslash continuation method. # Code continues below print('Hello, World!')> Izhod:
Hello, World!>
Dokumentni nizi v Pythonu
The docstring je vgrajena funkcija Pythona, ki se uporablja 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 Python __doc__ atribut.
nauči se selena
Primer: nizi dokumentov v Pythonu
V tem primeru smo po definiranju funkcije multiply() deklarirali komentar niza dokumenta s trojnimi narekovaji. Nato natisnemo niz dokumenta z uporabo atributa __doc__.
Python3 def multiply(a, b): '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>
Izhod:
Multiplies the value of a and b>
Razlika med komentarji in nizom dokumentov v Pythonu
Poglejmo razliko med komentarji Python in Docstring:
Komentarji | Dokumentarni nizi |
|---|---|
| Razglašeni so z # | Deklarirani so z uporabo |
| Uporablja se za povečanje berljivosti kode | Poda opis modulov, funkcij in razredov Python |
| Do njih ni mogoče dostopati | Do njih lahko dostopate z __doc__ |