Hoe commentarieer je een blok code in Python

Comments zijn een van de handigste hulpmiddelen bij het werken met Python. Ze leiden ons door de logica, keuzes en doelen achter codeblokken zonder de uitvoering te verstoren. Opmerkingen maken de code beter leesbaar en onderhoudbaar en bevorderen samenwerking binnen een team.

In deze tutorial behandelen we twee effectieve methoden om meerdere regels code in Python uit te commentariëren, zodat je code goed gedocumenteerd en makkelijk te begrijpen is.

Waarom zijn blokopmerkingen in Python belangrijk?

Opmerkingen zijn vaak een van de eerste concepten die je tegenkomt in je Python-leertraject. Ze geven nuttige context over de bedoeling achter een bepaalde codefragment. Ze bieden duidelijkheid en context over waarom een script zich gedraagt zoals het doet. Er zijn allerlei belangrijke redenen waarom je in je scripts altijd opmerkingen zou moeten gebruiken. Dit zijn er vier:

• Documentatie: Opmerkingen fungeren als documentatie die het doel van functies, klassen of codeblokken uitlegt. Dit is vooral nuttig bij complexe algoritmen waarbij de logica niet direct duidelijk is.
• Leesbaarheid: Goed van opmerkingen voorziene code is makkelijker te lezen en te begrijpen. Dit is cruciaal wanneer jij of anderen de code na enige tijd weer bekijken.
• Debuggen: Tijdelijk secties code uitcommentariëren is een veelgebruikte methode om bugs te isoleren en te vinden.
• Samenwerking: In een teamomgeving maken opmerkingen code beter deelbaar en begrijpelijker, wat soepelere samenwerking en code reviews bevordert.

Enkelregelige blokopmerkingen in Python gebruiken

Voordat we ingaan op het uitcommentariëren van meerdere regels, beginnen we met de basis van enkelregelige opmerkingen. In Python begint een enkelregelige opmerking met het hekje (#), en de Python-interpreter negeert alles wat erna komt op die regel. Volg onderstaande instructies om een enkelregelige opmerking te maken:

1. Plaatsing: Zet het #-symbool aan het begin van de regel of na de code op dezelfde regel. Opmerkingen kunnen boven de code staan die ze beschrijven, rechts op dezelfde regel, of losstaand.
2. Inhoud: Schrijf na het #-symbool je opmerking. Dit kan een uitleg zijn van de coderegel, een notitie voor later, of andere nuttige informatie met betrekking tot de code.

# This is a single-line comment explaining the next line of code
print("Hello, world!")  # This prints a message to the console

Methode #1: Commentaar geven met meerdere enkele #

De meest rechttoe-rechtaan manier om in Python te commentariëren is met het #-symbool, dat alles uitcommentarieert wat erna komt op de regel. Hoewel Python geen specifieke syntaxis voor blokopmerkingen heeft, kun je meerdere #-symbolen gebruiken om elke regel afzonderlijk uit te commentariëren. Het enige wat je hoeft te doen is het volgende:

1. Identificeer het codeblok: Bepaal eerst welk codeblok je wilt uitcommentariëren. Dit kan een functie, een lus of een ander segment van je code zijn dat je wilt uitschakelen of toelichten.
2. Voorzie elke regel van commentaar: Zet een #-symbool aan het begin van elke regel die je wilt uitcommentariëren. Dit vertelt de Python-interpreter dat deze regels tijdens de uitvoering genegeerd moeten worden.

Zie het onderstaande voorbeeld:

# Example of commenting out multiple lines individually 
# print("Hello, world")
# print("What are you up to?")

print("Just floating in space. What was the question?")

Python blokcommentaar-methode #2: Commentaar met drievoudig gequote stringliteralen

Een alternatieve methode om meerdere regels uit te commentariëren is het gebruik van drievoudig gequote stringliteralen (''' ''' of """ """). Hoewel dit officieel geen blokopmerkingen zijn, worden deze stringliteralen vaak zo gebruikt, vooral voor meerregelige opmerkingen of docstrings. Om drievoudig gequote strings te gebruiken, plaats je simpelweg ''' of """ vóór en na het codeblok dat je wilt uitcommentariëren, zoals hieronder:

'''
def example_function(name):
	print("Hello", name)
'''

Drievoudig gequote stringliteralen worden het meest gebruikt voor het documenteren van Python-functies. Bijvoorbeeld:

# Create hello() function
def hello(name):
	'''
	This function takes as input a name, 
	and returns a salutation to the name in the form of "Hello name"
	'''
	# Print the output 
	print("Hello", name)

hello("John")

Deze drievoudig gequote stringliteralen heten docstrings — je kunt er meer over lezen in onze docstrings-tutorial.