Wie man einen Codeblock in Python auskommentiert

Kommentare sind eine der nützlichsten Werkzeuge beim Arbeiten mit Python. Sie führen uns durch die Logik, Entscheidungen und Zwecke hinter Codeblöcken, ohne die Ausführung zu stören. Kommentare helfen, den Code lesbarer und wartbarer zu machen und die Zusammenarbeit in einem Team zu fördern.

In diesem Tutorial werden wir uns zwei effektive Methoden zur Kommentierung mehrerer Codezeilen in Python ansehen, um Ihren Code gut dokumentiert und leicht verständlich zu halten.

Warum sind Blockkommentare in Python wichtig?

Kommentare sind oft eines der ersten Konzepte, die Sie auf Ihrer Python-Lernreise begegnen. Sie bieten nützlichen Kontext über die Absicht hinter einem bestimmten Codeausschnitt. Sie bieten Klarheit und Kontext darüber, warum ein Skript so funktioniert, wie es tut. Es gibt eine Vielzahl von wichtigen Gründen, warum Sie in Ihren Skripten immer Kommentare verwenden sollten. Hier sind vier davon:

• Dokumentation: Kommentare dienen als Form der Dokumentation, die den Zweck von Funktionen, Klassen oder Codeblöcken erklärt. Dies ist besonders nützlich für komplexe Algorithmen, wo die Logik nicht unmittelbar offensichtlich ist.
• Lesbarkeit: gut kommentierter Code ist einfacher zu lesen und zu verstehen. Dies ist entscheidend, wenn Sie oder andere den Code nach einiger Zeit wieder aufgreifen.
• Fehlersuche: Die vorübergehende Kommentierung von Codeabschnitten ist eine gängige Praxis, um Fehler zu isolieren und zu identifizieren.
• Zusammenarbeit: In einem Team-Umfeld verleihen Kommentare dem Code eine größere Verteilbarkeit und Verständlichkeit, was die Zusammenarbeit und den Code-Review-Prozess erleichtert.

Verwendung von Einzelzeilen-Blockkommentaren in Python

Vor wir uns den Kommentieren mehrerer Zeilen näher anschauen, lernen wir als erstes die Grundlagen der Einzeilenkommentare kennen. In Python beginnt ein Einzeilenkommentar mit dem Schrägstrich (#), und der Python-Interpreter ignoriert alles, was folgt auf derselben Zeile. Um ein Einzeilenkommentar zu erstellen, folgen Sie den unten stehenden Anweisungen:

1. Platzierung: Legen Sie den #-Zeichen am Anfang der Zeile oder danach auf derselben Zeile. Kommentare können über dem Code stehen, der beschrieben werden soll, direkt neben dem Code auf der rechten Seite oder separat platziert werden.
2. Inhalt: Schreiben Sie Ihren Kommentar nach dem #-Zeichen. Dies kann eine Erklärung der folgenden Zeile des Codes sein, ein Notiz für die Zukunft oder jeder nutzbare Information, die mit dem Code in Verbindung steht.

# Dies ist ein Einzeilenkommentar, der die nächste Zeile des Codes erklärt
print("Hello, world!")  # Dies sendet eine Nachricht an die Konsole

Methode #1: Kommentieren mit mehreren Einzelzeilen-#

Das Einfachste, um in Python zu kommentieren, besteht darin, das Symbol # zu verwenden, das alles, was ihm auf der Zeile folgt, als Kommentar markiert. Obwohl Python kein bestimmtes Syntax für Blockkommentare hat, können Sie mehrere #-Symbole verwenden, um jede Zeile einzeln zu kommentieren. Führen Sie die folgenden Schritte aus:

1. Identifizieren Sie den Codeblock: Identifizieren Sie zunächst den Codeblock, den Sie kommentieren möchten. Dies kann eine Funktion, eine Schleife oder jeder andere Teil Ihres Codes sein, den Sie deaktivieren oder erklären möchten.
2. Kommentieren Sie jede Zeile: Plazieren Sie ein #-Symbol am Anfang jeder Zeile, die Sie kommentieren möchten. Dies sagt dem Python-Interpreter, diese Zeilen während der Ausführung zu ignorieren.

Ein Beispiel finden Sie unten:

# Beispiel für das Kommentieren mehrerer Zeilen einzeln
# def example_function(name):
# 	# Diese Funktion druckt "Hallo " und den eingegebenen Namen
# 	print("Hallo", name)

Python Blockkommentarmethode #2: Kommentieren mit dreifach-gequoteten String-Literalen

Eine alternative Methode, um mehrere Zeilen zu Kommentar zu setzen, besteht darin, Dreifach-Zitat-Literalien (“‘ “‘ oder „““ „““) zu verwenden. Obwohl sie offiziell keine Blockkommentare sind, werden diese Zeichenfolgen oft als solche verwendet, insbesondere für Mehrzeilenkommentare oder Dokumentationszeilen. Um Dreifach-Zitat-Literalien zu verwenden, platzieren Sie einfach “‘ oder „““ vor und nach dem Block an Code, den Sie kommentieren möchten, wie in folgendem Beispiel gezeigt:

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

Dreifach-Zitat-Literalien werden am häufigsten zur Dokumentation Python-Funktionen verwendet. Zum Beispiel:

# Erstellen Sie 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"
	'''
	# Zeige die Ausgabe an
	print("Hello", name)

Diese Dreifach-Zitat-Literalien heißen Dokumentationszeilen — Sie können sich mehr über sie in unserem Lehrbuch über Dokumentationszeilen informieren.