Commentaar en leesbaarheid van code

Opmerkingen op meerdere regels kun je schrijven met drievoudige aanhalingstekens (''' of """). Bijvoorbeeld:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Opmerkingen helpen bij:

• Het uitleggen van complexe code.
• Het begrijpelijker maken van code voor anderen en voor jezelf in de toekomst.
• Het opsporen van fouten en oplossen van problemen.

Onthoud: opmerkingen zijn voor mensen, niet voor de machine!

Hier zijn enkele tips voor het schrijven van goede opmerkingen:

• Houd opmerkingen beknopt en betekenisvol.
• Vermijd voor de hand liggende opmerkingen zoals # Increment x by 1 voor x = x + 1.
• Gebruik opmerkingen om uit te leggen waarom de code op een bepaalde manier is geschreven.

Leesbare code is gemakkelijker te onderhouden en te debuggen. Hier zijn enkele tips:

• Gebruik betekenisvolle namen voor variabelen en functies.
• Houd regels code kort.
• Organiseer code in secties met opmerkingen.

Je kunt opmerkingen gebruiken om code tijdelijk uit te schakelen voor foutopsporing. Bijvoorbeeld:

# print("This line is commented out and won’t run.")
print("This line will run.")

Je kunt opmerkingen gebruiken om functies te documenteren en hun doel uit te leggen:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

In deze les heb je het volgende geleerd:

• Hoe je opmerkingen op één regel en op meerdere regels schrijft in Python.
• Waarom opmerkingen belangrijk zijn voor de leesbaarheid en onderhoudbaarheid van code.
• Best practices voor het schrijven van opmerkingen en het verbeteren van de leesbaarheid van code.

Goed gedaan! Laten we doorgaan naar het volgende onderwerp.