Opmerkingen in Python zijn de regels in de code die door de tolk worden genegeerd tijdens de uitvoering van het programma.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Opmerkingen vergroten de leesbaarheid van de code en helpen de programmeurs de code zeer zorgvuldig te begrijpen. Het helpt ook bij het samenwerken met andere ontwikkelaars, omdat het toevoegen van opmerkingen het gemakkelijker maakt om de code uit te leggen.
Soorten opmerkingen in Python
Er zijn drie soorten opmerkingen in Python:
- Enkele regel opmerkingen
- Meerregelige opmerkingen
- Letterlijke tekenreeksen
- Docstring-opmerkingen
Opmerkingen in Python
In het voorbeeld is dat te zien Python Opmerkingen worden door de tolk genegeerd tijdens de uitvoering van het programma.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Uitgang:
geeksforgeeks>
Waarom worden opmerkingen gebruikt in Python?
Commentaar is een integraal onderdeel van programmeertalen, en elke taal heeft verschillende manieren om commentaar te gebruiken.
Net als elke andere taal dienen opmerkingen in Python het volgende doel:
- Verbeter de leesbaarheid van de code
- Code uitleggen aan anderen
- Code begrijpen als deze na enige tijd wordt bestudeerd
- Het documenteren van de stappen en behoeften voor een functie
- Code delen met collega-ontwikkelaars
- Samenwerken met meerdere mensen.
Soorten opmerkingen in Python
Laten we de verschillende soorten opmerkingen ontdekken, hoe we ze kunnen gebruiken en wanneer we ze moeten gebruiken?
1. Enkele lijn Opmerkingen
- Python-commentaar met één regel begint met het hashtag-symbool (#) zonder spaties en duurt tot het einde van de regel.
- Als het commentaar langer is dan één regel, plaats dan een hashtag op de volgende regel en ga verder met het Python-commentaar.
- De enkelregelige commentaren van Python zijn nuttig gebleken voor het geven van korte uitleg voor variabelen, functiedeclaraties en expressies. Zie het volgende codefragment dat commentaar van één regel demonstreert:
Voorbeeld:
Python3
Java-duur
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Uitvoer
techcodeview.com>
2. Commentaar met meerdere regels
Python biedt niet de optie voor opmerkingen met meerdere regels . Er zijn echter verschillende manieren waarop we opmerkingen met meerdere regels kunnen schrijven.
Java-afdruk
a) Meerregelige opmerkingen met meerdere hashtags (#)
We kunnen meerdere hashtags (#) gebruiken om opmerkingen met meerdere regels in Python te schrijven. Elke regel wordt beschouwd als commentaar van één regel.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Uitvoer
Multiline comments>
Controleer ook: Interessant feit over meerregelige opmerkingen in Python
3. Letterlijke tekenreeksen
Python negeert de tekenreeks letterlijke waarden die niet aan een variabele zijn toegewezen, zodat we deze letterlijke tekenreeksen kunnen gebruiken als Python-opmerkingen .
a) Commentaar van één regel met letterlijke tekenreeksen
Bij het uitvoeren van de bovenstaande code kunnen we zien dat er geen uitvoer zal zijn, dus gebruiken we de strings with drievoudige aanhalingstekens () als commentaar met meerdere regels.
Python3
'This will be ignored by Python'> |
>
>
b) Meerregelig commentaar met behulp van letterlijke tekenreeksen
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Uitvoer
Multiline comments>
4. Docstring
- Python-docstring is de letterlijke tekenreeks met drievoudige aanhalingstekens die direct na de functie verschijnen.
- Het 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 het attribuut __doc__.
Voorbeeld:
Python3
je s t
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>
Voordelen van opmerkingen in Python
Opmerkingen worden over het algemeen gebruikt voor de volgende doeleinden:
- Codeleesbaarheid
- Uitleg van de code of metadata van het project
- Voorkom uitvoering van code
- Om middelen op te nemen
Juiste manier om opmerkingen te schrijven
Opmerkingen dienen in de eerste plaats om uw code uit te leggen. Ontwikkelaars gebruiken gezonde schrijfpraktijken voor een beter begrip van de code.
Enkele tips die u kunt volgen om uw opmerkingen effectief te maken, zijn:
- Opmerkingen moeten kort en nauwkeurig zijn.
- Gebruik alleen commentaar als dat nodig is en zorg ervoor dat uw code niet vol staat met commentaar.
- Commentaar zou enige betekenis moeten hebben.
- Vermijd het schrijven van algemene of fundamentele opmerkingen.
- Schrijf opmerkingen die voor zichzelf spreken.
We hebben alles besproken over Python-commentaar, hoe je Python-commentaar schrijft, soorten commentaar, wat de voordelen zijn en de juiste manier om commentaar te schrijven.
Lees ook: Hoe schrijf je commentaar in Python3?