I denne artikkelen vil vi fordype oss i konseptet med flerlinjekommentarer i Python, og gi en omfattende definisjon sammen med illustrerende eksempler i Python-programmeringsspråket på Hvordan kommentere flere linjer i Python .
xd betydning
Hva er en flerlinjekommentar i Python?
Flerlinjekommentarer i Python refererer til en tekstblokk eller setninger som brukes til forklarings- eller dokumentasjonsformål i koden. I motsetning til enkeltlinjekommentarer angitt med hash-symbolet (#), er flerlinjekommentarer omgitt av trippel doble anførselstegn (``) eller trippel enkle anførselstegn (`’`). Disse kommentarene brukes ofte til å gi detaljerte forklaringer, dokumentasjon eller notater om koden, og de kan spenne over flere linjer. Selv om Python ikke har en spesifikk syntaks for kommentarer med flere linjer, oppnår bruk av tredoble anførselstegn en lignende effekt, ettersom tolken ignorerer den vedlagte teksten.
Typer flerlinjekommentarer i Python
Det er to måter vi kan legge til Python-flerlinjekommentarer i koden vår. De er som følger:
- Påfølgende enkeltlinjekommentar
- Bruke en flerlinjet streng som kommentar
- Bruker omvendt skråstrekmetode
Kommenter ut flere linjer i Python ved å bruke påfølgende enkeltlinjekommentarer
I Python , brukes hash-tegnet (#) for å kommentere linjen. Enkel linje kommentarer i Python trenger ikke å være tekst alene for å forklare koden, de kan også brukes til å hindre Python fra å kjøre kode. Hash-tegnet bør plasseres foran hver linje for å bli vurdert som flerlinjekommentarer i Python.
Eksempel: Påfølgende enkeltlinjekommentar
Her inneholder de to første linjene et hash-tegn(#), og tolken forhindrer at de to linjene kjøres. Deretter skriver den ut Python-kommentarene og til slutt vil den forhindre den siste linjen fra å kjøres.
Python3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>
Produksjon:
Python Comments>
Kommenter ut flere linjer i Python ved å bruke en flerlinjestreng som kommentar
Python-flerlinjekommentarer kan også omsluttes av et skilletegn (). Igjen skal det ikke være mellomrom mellom skilletegn (). De er nyttige når kommentarteksten ikke passer inn i én linje, og derfor må spenne over linjene. Denne typen strenglitteral blir ignorert siden den ikke er tilordnet noen variabel. Vi kan få tilgang til disse strengene ved å bruke __doc__.
Eksempel: Bruke en flerlinjestreng som kommentar
Flerlinjekommentarer brukes til å kommentere mer enn én linje. Den første linjen er en enkeltlinjekommentar. Den andre og tredje linjen kan kommenteres ved hjelp av tredoble anførselstegn( ). Dette forhindrer kjøring av koden ovenfor. Til slutt skriver den ut matematikk i utdataene. Imidlertid, hvis disse Python-flerlinjekommentarene plasseres direkte etter en funksjon eller klassesignatur, blir disse til docstrings .
Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>
Produksjon:
Mathematics>
Kommenter flere linjer i Python ved å bruke omvendt skråstrek-metode
En metode for å lage flerlinjekommentarer i Python innebærer å bruke omvendt skråstrek (``) på slutten av hver linje for å bruke linjefortsettingsfunksjonen, og dermed la kommentaren utvides til neste linje. Denne linjefortsettelsesmetoden er mindre vanlig enn andre tilnærminger som fortløpende enkeltlinjekommentarer eller flerlinjede strenger og brukes først og fremst for kodelesbarhetsformål når det er nødvendig å bryte en kommentar på tvers av flere linjer.
Eksempel : I dette eksemplet er kommentarene som begynner med#>
utvides til flere linjer ved hjelp av omvendt skråstrek (>
) på slutten av hver linje. Omvendt skråstrek indikerer at kommentaren fortsetter på neste linje. Denne metoden kan være nyttig for å forbedre kodelesbarheten når du har lange kommentarer.
# 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!')>
Utgang:
Hello, World!>
Docstrings i Python
De docstring er en innebygd funksjon i Python, som brukes til å knytte dokumentasjon som er skrevet med Python-moduler, funksjoner, klasser og metoder. Det legges til rett under funksjonene, modulene eller klassene for å beskrive hva de gjør. I Python blir docstringen deretter gjort tilgjengelig via Python __doc__ Egenskap.
Eksempel: Docstrings i Python
I dette eksemplet, etter at multiply()-funksjonen er definert, erklærte vi en docstring-kommentar ved å bruke de tre anførselstegnene. Deretter skriver vi ut docstringen ved å bruke __doc__-attributtet.
Python3 def multiply(a, b): '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>
Produksjon:
Multiplies the value of a and b>
Forskjellen mellom kommentarer og Docstring i Python
La oss se forskjellen mellom Python-kommentarer og Docstring:
Kommentarer | Docstrings |
---|---|
De er deklarert med # | De er erklært å bruke |
Brukes for å øke lesbarheten til koden | Gir en beskrivelse av Python-modulene, -funksjonene og -klassene |
De kan ikke nås | De kan nås ved å bruke __doc__ |