logo

Kelių eilučių komentarai Python

Šiame straipsnyje mes gilinsimės į kelių eilučių komentarų Python sąvoką, pateikdami išsamų apibrėžimą kartu su iliustraciniais pavyzdžiais Python programavimo kalba apie tai, kaip komentuoti kelias eilutes Python .

java žemėlapis

Kas yra kelių eilučių komentaras Python?

„Python“ kelių eilučių komentarai reiškia teksto arba teiginių bloką, kuris kode naudojamas aiškinamiesiems ar dokumentavimo tikslams. Skirtingai nei vienos eilutės komentarai, žymimi maišos simboliu (#), kelių eilučių komentarai pateikiami trigubomis dvigubomis kabutėmis (``) arba trigubomis viengubomis kabutėmis (```). Šie komentarai dažnai naudojami norint pateikti išsamius paaiškinimus, dokumentus ar pastabas apie kodą, ir jie gali apimti kelias eilutes. Nors Python neturi konkrečios sintaksės kelių eilučių komentarams, naudojant trigubas kabutes pasiekiamas panašus efektas, nes vertėjas nepaiso pridedamo teksto.



Kelių eilučių komentarų tipai Python

Yra du būdai, kaip į savo kodą įtraukti Python kelių eilučių komentarus. Jie yra tokie:

  • Iš eilės vienos eilutės komentaras
  • Kelių eilučių eilutės naudojimas kaip komentaras
  • Naudojant atgalinio pasvirojo brūkšnio metodą

Komentuokite kelias eilutes Python naudodami nuoseklų vienos eilutės komentarą

Į Python , maišos simbolis (#) naudojamas komentuoti eilutę. Viena linija komentarai Python neturi būti vien tekstas, kad paaiškintų kodą, jie taip pat gali būti naudojami siekiant neleisti Python vykdyti kodo. Maišos simbolis turėtų būti dedamas prieš kiekvieną eilutę, kad jis būtų laikomas kelių eilučių komentarais Python.

Pavyzdys: nuoseklus vienos eilutės komentaras

Čia pirmosiose dviejose eilutėse yra maišos simbolis (#), o vertėjas neleidžia vykdyti dviejų eilučių. Tada jis išspausdina Python komentarus ir galiausiai neleis vykdyti paskutinės eilutės.



Python3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

Išvestis:

Python Comments>

Komentuokite kelias eilutes Python naudodami kelių eilučių eilutę kaip komentarą

Python kelių eilučių komentarai taip pat gali būti įterpti į skyriklį (). Vėlgi, tarp skiriamųjų ženklų () neturėtų būti baltų tarpų. Jie naudingi, kai komentaro tekstas netelpa į vieną eilutę, todėl turi apimti eilutes. Šio tipo eilutės literatūra yra ignoruojama, nes ji nėra priskirta jokiam kintamajam. Šias eilutes galime pasiekti naudodami __doc__.

Pavyzdys: kelių eilučių eilutės naudojimas kaip komentaras

Kelių eilučių komentarai naudojami komentuoti daugiau nei vieną eilutę. Pirmoji eilutė yra vienos eilutės komentaras. Antrą ir trečią eilutes galima komentuoti naudojant trigubas kabutes ( ). Tai neleidžia vykdyti aukščiau nurodyto kodo. Galiausiai išvestyje išspausdinama matematika. Tačiau jei šie Python kelių eilučių komentarai dedami tiesiai po funkcijos ar klasės parašo, jie virsta dokumentai .



Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

Išvestis:

Mathematics>

Komentuokite kelias Python eilutes naudodami pasvirojo brūkšnio metodą

Kelių eilučių komentarų kūrimo „Python“ metodas apima pasvirojo brūkšnio (``) naudojimą kiekvienos eilutės pabaigoje, kad būtų panaudota eilutės tęsimo funkcija, taip leidžiant komentarą išplėsti iki kitos eilutės. Šis eilutės tęsimo metodas yra mažiau paplitęs nei kiti metodai, pvz., nuoseklūs vienos eilutės komentarai ar kelių eilučių eilutės, ir pirmiausia naudojamas kodo skaitomumo tikslais, kai reikia pertraukti komentarą keliose eilutėse.

Pavyzdys : Šiame pavyzdyje komentarai prasideda#>yra išplėsti iki kelių eilučių naudojant pasvirąjį brūkšnį (>) kiekvienos eilutės pabaigoje. Pasvirasis brūkšnys rodo, kad komentaras tęsiamas kitoje eilutėje. Šis metodas gali būti naudingas norint pagerinti kodo skaitomumą, kai rašote ilgus komentarus.

Java masyvo sąrašo metodai
Python3
# 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!')>

Išvestis:

Hello, World!>

„Docstrings“ Python

The dokstring yra integruota Python funkcija, naudojama susieti dokumentaciją, parašytą 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 per Python __doc__ atributas.

Pavyzdys: „Python“ dokumentų eilutės

Šiame pavyzdyje apibrėžę funkciją multiply() paskelbėme docstyling komentarą naudodami trigubas kabutes. Tada spausdiname dokumentų eilutę naudodami atributą __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__)>

Išvestis:

Multiplies the value of a and b>

„Python“ komentarų ir dokumentų eilutės skirtumas

Pažiūrėkime, kuo skiriasi Python komentarai ir „Docstring“:

Komentarai

Dokumentų eilutės

log4j
Jie deklaruojami naudojant #Jie deklaruojami naudojant
Naudojamas siekiant padidinti kodo skaitomumąPateikiamas Python modulių, funkcijų ir klasių aprašymas
Prie jų negalima prieitiJuos galima pasiekti naudojant __doc__