In deze tutorial leren we met behulp van voorbeelden opmerkingen te maken in Python.
Video: opmerkingen in Python
Opmerkingen zijn beschrijvingen die programmeurs helpen de bedoeling en functionaliteit van het programma beter te begrijpen.
Ze worden volledig genegeerd door de Python-interpreter.
Voordelen van het gebruik van opmerkingen
Door opmerkingen in programma's te gebruiken, wordt onze code begrijpelijker. Het maakt het programma beter leesbaar, wat ons helpt te onthouden waarom bepaalde codeblokken zijn geschreven.
Anders dan dat, kunnen opmerkingen ook worden gebruikt om bepaalde code te negeren tijdens het testen van andere codeblokken. Dit biedt een eenvoudige manier om de uitvoering van sommige regels te voorkomen of om een snelle pseudo-code voor het programma te schrijven.
Enkele regel opmerkingen in Python
In Python gebruiken we het hash-symbool #om een commentaar van één regel te schrijven.
Voorbeeld 1: opmerkingen van één regel schrijven
# printing a string print('Hello world')
Uitvoer
Hallo Wereld
Hier is de opmerking:
# printing a string
Deze regel wordt genegeerd door de Python-interpreter.
Alles wat daarna komt, #wordt genegeerd. We kunnen het bovenstaande programma dus ook op één regel schrijven als:
print('Hello world') #printing a string
De uitvoer van dit programma is hetzelfde als in Voorbeeld 1 . De tolk negeert alle tekst daarna #.
Meerregelige opmerkingen in Python
Python biedt geen aparte manier om commentaren op meerdere regels te schrijven. Er zijn echter andere manieren om dit probleem te omzeilen.
We kunnen #aan het begin van elke regel commentaar op meerdere regels gebruiken.
Voorbeeld 2: meerdere # gebruiken
# it is a # multiline # comment
Hier wordt elke regel behandeld als een enkele opmerking en ze worden allemaal genegeerd.
Letterlijke tekenreeksen voor opmerkingen met meerdere regels
Hoewel er geen unieke manier is om commentaar met meerdere regels in Python te schrijven, weten we dat de Python-interpreter de letterlijke tekenreeksen negeert die niet aan een variabele zijn toegewezen.
We kunnen dus zelfs een opmerking van één regel schrijven als:
#this is a comment 'this is an unassigned string as a comment '
Hier kunnen we zien dat de tweede regel van het programma een string is, maar niet is toegewezen aan een variabele of functie. Dus de tolk negeert de string.
Op een vergelijkbare manier kunnen we strings met meerdere regels (drievoudige aanhalingstekens) gebruiken om opmerkingen met meerdere regels te schrijven.
Het citaat karakter kan of 'of ".
Voorbeeld 3: String Literals gebruiken om commentaar van meerdere regels te schrijven
''' I am a multiline comment! ''' print("Hello World")
Hier is de multiline-string aan geen enkele variabele toegewezen, dus wordt deze genegeerd door de interpreter. Hoewel het technisch gezien geen commentaar met meerdere regels is, kan het als één commentaar worden gebruikt.
Python-docstrings
Volgens afspraak zijn de drievoudige aanhalingstekens die direct na de functie, methode of klassedefinitie verschijnen docstrings (documentatiereeksen).
Docstrings zijn geassocieerd met objecten en zijn toegankelijk via het __doc__attribuut.
Bezoek Python docstrings voor meer informatie.
Hoe kan ik betere opmerkingen schrijven?
- Gebruik opmerkingen om te beschrijven wat een functie doet en niet de specifieke details over hoe de functie het doet.
- Probeer zoveel mogelijk overtollige opmerkingen te verwijderen. Probeer code te schrijven die zichzelf kan verklaren, met een betere keuze van functies / variabelenamen.
- Probeer de opmerkingen zo kort en beknopt mogelijk te maken.
