logo

Meerregelig commentaar in Python

In dit artikel zullen we dieper ingaan op het concept van meerregelig commentaar in Python, waarbij we een uitgebreide definitie geven samen met illustratieve voorbeelden in de programmeertaal Python over het reageren op meerdere regels in Python .

Wat is een meerregelig commentaar in Python?

Meerregelig commentaar in Python verwijst naar een tekstblok of instructies die worden gebruikt voor verklarende of documentatiedoeleinden binnen de code. In tegenstelling tot commentaar met één regel, aangegeven met het hekje (#), worden commentaar met meerdere regels omsloten door drievoudige dubbele aanhalingstekens (``) of drievoudige enkele aanhalingstekens (`’`). Deze opmerkingen worden vaak gebruikt om gedetailleerde uitleg, documentatie of opmerkingen over de code te geven, en kunnen meerdere regels beslaan. Hoewel Python geen specifieke syntaxis heeft voor commentaar met meerdere regels, bereikt het gebruik van drievoudige aanhalingstekens een soortgelijk effect, omdat de tolk de ingesloten tekst negeert.



Soorten meerregelige opmerkingen in Python

Er zijn twee manieren waarop we Python-meerregelige opmerkingen in onze code kunnen toevoegen. Ze zijn als volgt:

  • Opeenvolgende commentaar van één regel
  • Een tekenreeks met meerdere regels gebruiken als commentaar
  • Met behulp van de Backslash-methode

Geef commentaar op meerdere regels in Python met behulp van opeenvolgende opmerkingen van één regel

In Python , wordt het hash-teken (#) gebruikt om commentaar op de regel te geven. Enkele lijn opmerkingen in Python hoeven niet alleen tekst te zijn om de code uit te leggen, ze kunnen ook worden gebruikt om te voorkomen dat Python code uitvoert. Het hash-teken moet vóór elke regel worden geplaatst om in Python als commentaar met meerdere regels te worden beschouwd.

Voorbeeld: opeenvolgende commentaar van één regel

Hier bevatten de eerste twee regels een hash-teken (#) en voorkomt de interpreter dat de twee regels worden uitgevoerd. Vervolgens worden de Python-opmerkingen afgedrukt en ten slotte wordt voorkomen dat de laatste regel wordt uitgevoerd.



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

Uitgang:

Python Comments>

Geef commentaar op meerdere regels in Python met behulp van een multiline-string als commentaar

Meerregelige Python-opmerkingen kunnen ook worden omsloten door een scheidingsteken (). Ook hier mag er geen witruimte tussen de scheidingstekens () staan. Ze zijn handig als de commentaartekst niet op één regel past en daarom over meerdere regels moet lopen. Dit type letterlijke tekenreeks wordt genegeerd omdat het aan geen enkele variabele is toegewezen. We hebben toegang tot deze strings met behulp van __doc__.

nadelen van internet

Voorbeeld: gebruik van een tekenreeks met meerdere regels als commentaar

Meerregelig commentaar wordt gebruikt om commentaar te geven op meer dan één regel. De eerste regel is een commentaar van één regel. Er kan commentaar worden gegeven op de tweede en derde regel met behulp van drievoudige aanhalingstekens ( ). Dit verhindert de uitvoering van de bovenstaande code. Ten slotte wordt Wiskunde in de uitvoer afgedrukt. Als deze meerregelige Python-opmerkingen echter direct na een functie- of klassehandtekening worden geplaatst, worden deze omgezet in docstrings .



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

Uitgang:

Mathematics>

Geef commentaar op meerdere regels in Python met behulp van de Backslash-methode

Een methode om commentaar met meerdere regels in Python te maken, omvat het gebruik van de backslash (``) aan het einde van elke regel om gebruik te maken van de regelvoortzettingsfunctie, waardoor het commentaar kan worden uitgebreid naar de volgende regel. Deze methode voor het voortzetten van regels is minder gebruikelijk dan andere benaderingen, zoals opeenvolgende opmerkingen van één regel of reeksen met meerdere regels, en wordt voornamelijk gebruikt voor de leesbaarheid van de code wanneer het nodig is om een ​​commentaar over meerdere regels te verdelen.

Voorbeeld : In dit voorbeeld beginnen de opmerkingen met#>worden uitgebreid naar meerdere regels met behulp van de backslash (>) aan het einde van elke regel. De backslash geeft aan dat het commentaar doorgaat op de volgende regel. Deze methode kan handig zijn om de leesbaarheid van de code te verbeteren als u lange opmerkingen heeft.

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

Uitgang:

Hello, World!>

Docstrings in Python

De docstring is een ingebouwde functie van Python, die wordt gebruikt om documentatie te koppelen die is geschreven met Python-modules, functies, klassen en methoden. Het wordt direct onder de functies, modules of klassen toegevoegd om te beschrijven wat ze doen. In Python wordt de docstring vervolgens beschikbaar gesteld via de Python __doc__ attribuut.

Voorbeeld: Docstrings in Python

In dit voorbeeld hebben we, nadat de functie multiply() is gedefinieerd, een docstring-opmerking gedeclareerd met behulp van de drievoudige aanhalingstekens. Vervolgens drukken we de docstring af met behulp van het attribuut __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__)>

Uitgang:

Multiplies the value of a and b>

Verschil tussen opmerkingen en Docstring in Python

Laten we eens kijken naar het verschil tussen Python-opmerkingen en Docstring:

Opmerkingen

Docstrings

naamconventie java
Ze worden gedeclareerd met #Ze worden aangegeven met
Wordt gebruikt om de leesbaarheid van de code te vergrotenGeeft een beschrijving van de Python-modules, -functies en -klassen
Ze zijn niet toegankelijkZe zijn toegankelijk via __doc__