Uitleg: Comments in Python

Het achterlaten van reminders of het omschrijven van een functionaliteit in de code zelf gebeurt aan de hand van comments. Wanneer je Python professioneel gebruikt of met meerdere personen aan hetzelfde project werkt zijn comments onmisbaar. Comments helpen je te onthouden waar je gebleven bent in je vorige werksessie of waarom je in het verleden bepaalde keuzes gemaakt hebt. De syntax voor comments in Python is erg eenvoudig. In Python wordt er onderscheid gemaakt tussen single en multi line comments.

Single line comments

Om een comment toe te voegen in Python gebruik je een # (hashtag) gevold door een spatie. Alles wat je na de hashtag schrijft wordt door de interpreter als comment gezien en wordt dus niet meegenomen in de uitvoering van de code. Je kunt comments op twee manieren gebruiken: om een aantekening of beschrijving toe te voegen en om een stuk code uit te sluiten van uitvoering. Door een hashtag voor de tekst te voegen hoef je de code dus niet te verwijderen of naar een ander bestand te verplaatsen.

# dit is een single line comment

De single line comments kun je zowel buiten als tussen de code door schrijven, ook wel block comments genoemd. Door een hashtag voor de tekst te plaatsen begrijpt de interpreter dat de tekst geen string maar een comment is. Deze zijn vooral nuttig bij het uitleggen van een stuk complexere code of bij het aangeven van relevante gegevens. Denk hierbij bijvoorbeeld aan de functie, maar ook aan wie de schrijver is en wanneer dit stuk voor het laatst is aangepast. Je kunt daarnaast ook comments toevoegen aan het einde van een regel code, dit noemt men inline comments. Inline comments worden typisch gebruikt om bepaalde keuzes uit te leggen.

# Titel: Dit is een typisch voorbeeld van een block comment
# Geschreven door: Piet Python
# Voor het laatst bewerkt op: 1-1-2079 

print("Comments zijn heel erg handig!") # Dit is een inline comment

Multi line comments

Om comments bestaande uit meerdere regels toe te voegen of een stuk code dat uitsluiten dat uit meerdere regels bestaat kun je een multi line comment gebruiken. Deze worden aangegeven met “”” (3 aanhalingstekens). Multi line comments hebben precies hetzelfde effect als wanneer je van iedere lijn een single line comment zou maken. Het verschil hierbij is echter dat een multi line comment veel tijd efficiënter is en netter oogt.

"""Dit is een comment dat uit meerdere regels tekst bestaat.
Hierbij een stuk lorem Ipsum:
Lorem ipsum dolor sit amet,
consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."""

# Eerst vragen we iemand om zijn naam
print("Goedemiddag! Wat is jouw naam?")
naam = input()
print("Aangenaam kennis te maken "+ naam)

"""
In het stukje code hieronder vragen we 
of iemand ook comments gebruikt
"""

print('Gebruik jij comments?') 
commentsAntwoord = input()
if commentsAntwoord == "Ja":
    print("Ha mooi! Je gebruikt comments.") # Ga zo door ;)
else:
    print("Zonde! Comments kunnen heel handig zijn.") 

# print("Deze tekst wordt niet geprint omdat er een hashtag vooraan de regel staat")

Documentation comments

In Python kun je zogeheten documentation comments plaatsen. Bij het aanmaken van een functie kun je op de eerste rij na het definiëren van de functie een comments tussen 3 aanhalingstekens plaatsen. Vervolgens kun je via help() de gehele documentatie van de module en haar functies bekijken. Met help(naam_module.functie_naam) kun je enkel de beschrijving van een specifieke functie uitlezen.

def een_functie(tekst):
  """Dit is de documentatie."""
  woorden = tekst.split(' ')
  return woorden

In de Terminal ziet het opvragen van de documentation comments er als volgt uit:

python3
>>>help(module_1)
# Hier volgt een uitleg)
>>>help(module_1.een_functie)
# Hier lees je informatie over enkel deze specifieke functie