Kommentare in Python hinzufügen

Einführung

In diesem Lab lernen Sie die Bedeutung und die praktische Anwendung von Kommentaren in Python kennen. Kommentare sind unerlässlich, um Ihren Code verständlich zu machen, was für Wartung und Zusammenarbeit entscheidend ist. Sie werden verschiedene Arten von Kommentaren erkunden, einschließlich einzeiliger und mehrzeiliger Kommentare, und lernen, wie Sie diese effektiv einsetzen können, um die Lesbarkeit des Codes zu verbessern.

Den Zweck von Kommentaren verstehen

Kommentare sind Anmerkungen innerhalb Ihres Codes, die vom Python-Interpreter ignoriert werden, aber für menschliche Leser wertvoll sind. Sie helfen dabei, die Logik, den Zweck und alle nicht offensichtlichen Details des Codes zu erklären. Während eine Maschine den Code ausführt, sind es Menschen, die ihn lesen und warten müssen. Gute Kommentierungsgewohnheiten sind unerlässlich für das Schreiben von sauberem und verständlichem Programmcode.

Beginnen wir mit einem einfachen Skript ohne jegliche Kommentare. Suchen Sie im WebIDE im Dateiexplorer auf der linken Seite die Datei purpose.py und öffnen Sie diese.

Fügen Sie den folgenden Code in die Datei purpose.py ein:

x = 10
y = 20
z = x + y
print(z)

Speichern Sie die Datei, indem Sie Strg + S drücken.

Um das Skript auszuführen, öffnen Sie das integrierte Terminal im WebIDE, indem Sie im oberen Menü zu Terminal -> New Terminal navigieren. Das Terminal öffnet sich am unteren Bildschirmrand, und der Standardpfad ist ~/project.

Führen Sie das Skript aus, indem Sie den folgenden Befehl im Terminal eingeben:

python purpose.py

Sie sehen die Ausgabe der Berechnung:

30

Dieses Skript ist unkompliziert, aber in einem größeren Programm ist möglicherweise nicht sofort ersichtlich, wofür x, y und z stehen. Im nächsten Schritt werden wir Kommentare hinzufügen, um diesen Code leichter verständlich zu machen.

Einzeilige Kommentare verwenden

Einzeilige Kommentare werden für kurze, erklärende Notizen verwendet. In Python beginnt ein einzeiliger Kommentar mit dem Hash-Symbol (#). Der Interpreter ignoriert alles auf der Zeile, was auf das # folgt. Diese Kommentare können entweder in einer separaten Zeile platziert werden, um den folgenden Code zu beschreiben, oder in derselben Zeile wie eine Anweisung, um diese zu erklären.

Lassen Sie uns die Datei purpose.py ändern, um einzeilige Kommentare einzufügen. Öffnen Sie purpose.py im Editor und aktualisieren Sie den Inhalt wie folgt:

## This script calculates the sum of two numbers

x = 10  ## Assign the integer 10 to variable x
y = 20  ## Assign the integer 20 to variable y
z = x + y  ## Calculate the sum of x and y
print(z) ## Print the final result to the console

Speichern Sie die Datei (Strg + S) und führen Sie sie erneut im Terminal aus:

python purpose.py

Die Ausgabe wird dieselbe sein wie zuvor:

30

Wie Sie sehen, haben die Kommentare das Verhalten des Programms nicht verändert. Der Code ist jedoch nun wesentlich besser lesbar. Der erste Kommentar erklärt den Gesamtzweck des Skripts, während die Inline-Kommentare die Rolle jeder Zeile verdeutlichen.

Mehrzeilige Kommentare verwenden

Für längere Erklärungen, die sich über mehrere Zeilen erstrecken, können Sie das Format für mehrzeilige Kommentare verwenden. Obwohl Python, anders als einige andere Sprachen, keine spezifische Syntax für mehrzeilige Kommentare hat, können Sie zu diesem Zweck mehrzeilige Strings verwenden.

Ein mehrzeiliger String wird erstellt, indem Text in dreifache Anführungszeichen eingeschlossen wird, entweder """...""" (doppelt) oder '''...''' (einfach). Wenn dieser mehrzeilige String keiner Variablen zugewiesen wird, ignoriert der Python-Interpreter ihn, wodurch er effektiv zu einem Kommentar wird. Dies ist eine gängige Konvention für das Schreiben von Blockkommentaren oder Funktionsdokumentationen (Docstrings).

Suchen und öffnen Sie die Datei multiline.py im WebIDE. Fügen Sie den folgenden Code hinzu:

"""
This is a multi-line comment using triple double quotes.
This script demonstrates how to write comments that span
several lines to provide more detailed explanations.
"""

message = "Hello, Python learners!"
print(message)

Speichern Sie die Datei und führen Sie sie im Terminal aus:

python multiline.py

Sie sehen die folgende Ausgabe:

Hello, Python learners!

Der Textblock innerhalb der dreifachen Anführungszeichen wurde ignoriert, und nur die print-Anweisung wurde ausgeführt. Diese Technik ist sehr nützlich, um detaillierte Beschreibungen am Anfang einer Datei oder vor einer komplexen Funktion bereitzustellen.

Deklarationskommentare verwenden

Python unterstützt auch spezielle Kommentare, die als Deklarationskommentare bekannt sind. Diese werden vom Interpreter oder dem Betriebssystem verarbeitet, um zu konfigurieren, wie das Skript ausgeführt wird. Zwei gängige Beispiele sind der Shebang und die Kodierungsdeklaration.

1. Shebang (#!): Die Shebang-Zeile ist die allererste Zeile eines Skripts. Sie teilt einem Unix-ähnlichen Betriebssystem mit, welchen Interpreter es verwenden soll, um die Datei auszuführen. Für ein Python 3-Skript ist dies typischerweise #!/usr/bin/python3. Dies ermöglicht es Ihnen, das Skript als eigenständige ausführbare Datei auszuführen.

2. Kodierungsdeklaration (Encoding Declaration): Dieser Kommentar teilt dem Python-Interpreter mit, welche Zeichenkodierung für die Quelldatei verwendet werden soll. Dies ist wichtig, wenn Ihr Code Nicht-ASCII-Zeichen enthält. Die Standarddeklaration für UTF-8 lautet ## -*- coding: utf-8 -*-. Sie sollte in der ersten oder zweiten Zeile der Datei platziert werden.

Erstellen wir ein Skript, das beide verwendet. Öffnen Sie die Datei declaration.py im Editor und fügen Sie den folgenden Code hinzu:

#!/usr/bin/python3
## -*- coding: utf-8 -*-

## This script demonstrates declaration comments and non-ASCII characters.
print("Hello, World!")
print("你好，世界！") ## A greeting in Chinese

Speichern Sie die Datei. Bevor Sie dieses Skript direkt ausführen können, müssen Sie es ausführbar machen. Führen Sie im Terminal den Befehl chmod aus:

chmod +x declaration.py

Nun können Sie das Skript direkt ausführen, ohne zuerst python eingeben zu müssen:

./declaration.py

Die Ausgabe zeigt beide Textzeilen korrekt an, einschließlich der chinesischen Zeichen:

Hello, World!
你好, 世界!

Die Shebang-Zeile ermöglichte es dem System, den Python 3-Interpreter zu finden und zu verwenden, und die Kodierungsdeklaration stellte sicher, dass die Nicht-ASCII-Zeichen korrekt verarbeitet wurden.

Zusammenfassung

In diesem Lab haben Sie gelernt, wie man Python-Code kommentiert. Sie haben geübt, einzeilige Kommentare mit # für kurze Notizen, mehrzeilige Kommentare mit """...""" für längere Beschreibungen und spezielle Deklarationskommentare wie den Shebang und die Kodierungsdeklaration zur Konfiguration der Skriptausführung zu verwenden. Durch effektives Kommentieren Ihres Codes machen Sie ihn lesbarer, wartbarer und leichter verständlich für andere (und Ihr zukünftiges Ich).