Auskommentieren eines Codeblocks in Python

Kommentare sind eines der nützlichsten Werkzeuge bei der Arbeit mit Python. Sie führen uns durch die Logik, die Entscheidungen und die Ziele hinter den Codeblöcken, ohne sich in die Ausführung einzumischen. Kommentare tragen dazu bei, dass der Code besser lesbar und wartbar ist und erleichtern die Zusammenarbeit im Team.

In diesem Lernprogramm lernst du zwei effektive Methoden kennen, mit denen du mehrere Codezeilen in Python auskommentieren kannst, damit dein Code gut dokumentiert und leicht verständlich ist.

Warum sind Blockkommentare in Python wichtig?

Kommentare sind oft eines der ersten Konzepte, die dir auf deiner Python-Lernreise begegnen. Sie liefern nützlichen Kontext über die Absicht hinter einem bestimmten Codeschnipsel. Sie bieten Klarheit und Kontext darüber, warum sich ein Skript so verhält, wie es sich verhält. Es gibt eine Reihe von wichtigen Gründen, warum du in deinen Skripten immer Kommentare verwenden solltest. Hier sind vier von ihnen:

• Dokumentation: Kommentare dienen als eine Art Dokumentation, die den Zweck von Funktionen, Klassen oder Codeblöcken erklärt. Das ist besonders nützlich für komplexe Algorithmen, bei denen die Logik vielleicht nicht sofort ersichtlich ist.
• Lesbarkeit: Gut kommentierter Code ist leichter zu lesen und zu verstehen. Das ist wichtig, wenn du oder andere den Code nach einiger Zeit wieder aufrufen.
• Fehlersuche: Das vorübergehende Auskommentieren von Codeabschnitten ist eine gängige Praxis, um Fehler zu isolieren und zu identifizieren.
• Kollaboration: In einer Teamumgebung machen Kommentare den Code leichter zugänglich und verständlich, was die Zusammenarbeit und die Code-Reviews vereinfacht.

Einzeilige Blockkommentare in Python verwenden

Bevor wir uns mit dem Auskommentieren von mehreren Zeilen beschäftigen, wollen wir mit den Grundlagen von einzeiligen Kommentaren beginnen. In Python beginnt ein einzeiliger Kommentar mit dem Raute-Symbol (#), und der Python-Interpreter ignoriert alles, was in dieser Zeile folgt. Um einen einzeiligen Kommentar zu erstellen, befolge die folgenden Anweisungen:

1. Platzierung: Setze das #-Symbol an den Anfang der Zeile oder nach dem Code in dieselbe Zeile. Kommentare können über dem Code, den sie beschreiben, in der gleichen Zeile rechts neben dem Code oder als eigenständige Zeile platziert werden.
2. Inhalt: Nach dem #-Symbol schreibst du deinen Kommentar. Dies kann eine Erläuterung der Codezeile, eine Notiz für spätere Bezugnahme oder eine andere nützliche Information zu dem Code sein.

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

Methode 1: Kommentierung mit mehreren einzeiligen #

Die einfachste Art, in Python zu kommentieren, ist die Verwendung des Symbols #, das alles auskommentiert, was in der Zeile darauf folgt. Python hat zwar keine spezielle Syntax für Blockkommentare, aber du kannst mehrere # Symbole verwenden, um jede Zeile einzeln auszukommentieren. Alles, was du tun musst, ist, die folgenden Schritte auszuführen:

1. Identifiziere den Codeblock: Identifiziere zunächst den Codeblock, den du auskommentieren möchtest. Das kann eine Funktion, eine Schleife oder ein beliebiger Teil deines Codes sein, den du deaktivieren oder erklären möchtest.
2. Kommentiere jede Zeile: Setze ein # Symbol an den Anfang jeder Zeile, die du auskommentieren möchtest. Damit wird der Python-Interpreter angewiesen, diese Zeilen bei der Ausführung zu ignorieren.

Du kannst das Beispiel unten sehen:

# Example of commenting out multiple lines individually 
# def example_function(name):
#	# This function prints "Hello " and the input name
# 	print("Hello", name)

Python Block Comment Method #2: Kommentare mit dreistelligen String-Literalen

Eine alternative Methode zum Auskommentieren mehrerer Zeilen ist die Verwendung von String-Literalen in dreifachen Anführungszeichen (''' ''' oder """ """). Obwohl sie offiziell keine Blockkommentare sind, werden diese String-Literale oft als solche verwendet, insbesondere für mehrzeilige Kommentare oder Docstrings. Um Zeichenketten in dreifachen Anführungszeichen zu verwenden, fügst du einfach ''' oder """ vor und nach dem Codeblock ein, den du auskommentieren möchtest, und zwar so:

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

String-Literale in dreifachen Anführungszeichen werden am häufigsten für die Dokumentation von Python-Funktionen verwendet. Zum Beispiel:

# Create example_function()
def example_function(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)

Diese dreifachen String-Literale in Anführungszeichen werden docstrings genannt - mehr dazu erfährst du in unserem docstrings-Tutorial.