logo

Multiline kommentarer i Python

I denne artikel vil vi dykke ned i begrebet multiline-kommentarer i Python og give en omfattende definition sammen med illustrative eksempler i Python-programmeringssproget om, hvordan man kommenterer flere linjer i Python .

xd betydning

Hvad er en flerlinjekommentar i Python?

Flerlinjekommentarer i Python henviser til en tekstblok eller sætninger, der bruges til forklarende eller dokumentationsformål i koden. I modsætning til enkeltlinjekommentarer angivet med hash-symbolet (#), er kommentarer med flere linier omgivet af tredobbelte dobbelte anførselstegn (``) eller tredobbelte enkeltanførselstegn (`’`). Disse kommentarer bruges ofte til at give detaljerede forklaringer, dokumentation eller noter om koden, og de kan strække sig over flere linjer. Selvom Python ikke har en specifik syntaks for kommentarer med flere linjer, opnår brug af tredobbelte anførselstegn en lignende effekt, da fortolkeren ignorerer den vedlagte tekst.



Typer af flerlinjekommentarer i Python

Der er to måder, hvorpå vi kan tilføje Python-flerlinjekommentarer i vores kode. De er som følger:

  • Fortløbende enkeltlinjekommentar
  • Brug af en flerlinjet streng som kommentar
  • Brug af backslash-metoden

Kommenter flere linjer i Python ved hjælp af fortløbende enkeltlinjekommentarer

I Python , bruges hash-tegnet(#) til at kommentere linjen. Enkeltlinje kommentarer i Python behøver ikke at være tekst alene for at forklare koden, de kan også bruges til at forhindre Python i at udføre kode. Hash-tegnet skal placeres før hver linje for at blive betragtet som flerlinjekommentarer i Python.

Eksempel: Konsekutiv enkeltlinjekommentar

Her indeholder de første to linjer et hash-tegn(#), og fortolkeren forhindrer de to linjer i at blive udført. Derefter udskriver den Python-kommentarerne og til sidst forhindrer den den sidste linje i at blive udført.



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

Produktion:

Python Comments>

Kommenter flere linjer i Python ved at bruge en flerlinjestreng som kommentar

Python-flerlinjekommentarer kan også omsluttes af en afgrænser (). Igen skal der ikke være mellemrum mellem afgrænsningstegn (). De er nyttige, når kommentarteksten ikke passer ind i én linje, og derfor skal strække sig over linjer. Denne type streng bliver ignoreret, da den ikke er tildelt nogen variabel. Vi kan få adgang til disse strenge ved hjælp af __doc__.

Eksempel: Brug af en flerlinjestreng som kommentar

Kommentarer med flere linjer bruges til at kommentere på mere end én linje. Den første linje er en enkelt-linje kommentar. Anden og tredje linje kan kommenteres ved hjælp af tredobbelte anførselstegn( ). Dette forhindrer udførelse af ovenstående kode. Til sidst udskriver den Matematik i outputtet. Men hvis disse Python-flerlinjekommentarer placeres direkte efter en funktion eller klassesignatur, bliver disse til docstrings .



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

Produktion:

Mathematics>

Kommenter flere linjer i Python ved hjælp af Backslash-metoden

En metode til at oprette kommentarer med flere linjer i Python involverer at bruge omvendt skråstreg (``) i slutningen af ​​hver linje for at bruge linjefortsættelsesfunktionen, og derved tillade kommentaren at udvide til næste linje. Denne linjefortsættelsesmetode er mindre udbredt end andre tilgange såsom på hinanden følgende enkeltlinjekommentarer eller flerlinjede strenge og bruges primært til kodelæselighedsformål, når det er nødvendigt at bryde en kommentar på tværs af flere linjer.

Eksempel : I dette eksempel er kommentarerne, der starter med#>udvides til flere linjer ved hjælp af omvendt skråstreg (>) i slutningen af ​​hver linje. Omvendt skråstreg angiver, at kommentaren fortsætter på næste linje. Denne metode kan være nyttig til at forbedre kodelæsbarheden, når du har lange kommentarer.

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!')>

Output:

Hello, World!>

Docstrings i Python

Det docstring er en indbygget funktion i Python, som bruges til at knytte dokumentation, der er skrevet med Python-moduler, -funktioner, -klasser og -metoder. Det er tilføjet lige under funktionerne, modulerne eller klasserne for at beskrive, hvad de gør. I Python gøres docstringen derefter tilgængelig via Python __doc__ attribut.

Eksempel: Docstrings i Python

I dette eksempel, efter multiply()-funktionen er defineret, erklærede vi en docstring-kommentar ved hjælp af de tredobbelte anførselstegn. Så udskriver vi docstringen ved hjælp af __doc__-attributten.

Python3
def multiply(a, b):  '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>

Produktion:

Multiplies the value of a and b>

Forskel mellem kommentarer og Docstring i Python

Lad os se forskellen mellem Python-kommentarer og Docstring:

Kommentarer

Docstrings

De erklæres ved hjælp af #De er erklæret vha
Bruges til at øge kodens læsbarhedGiver en beskrivelse af Python-modulerne, funktionerne og klasserne
De kan ikke tilgåsDe kan tilgås ved hjælp af __doc__