Kommentare in Python hinzufügen

PythonPythonBeginner
Jetzt üben

💡 Dieser Artikel wurde von AI-Assistenten übersetzt. Um die englische Version anzuzeigen, können Sie hier klicken

Einleitung

In diesem Lab lernen Sie die Bedeutung und praktische Anwendung von Kommentaren in der Python-Programmierung kennen. Kommentare sind unerlässlich, um Ihren Code für Menschen verständlich zu machen, was für die Wartung und Zusammenarbeit entscheidend ist, insbesondere wenn Programme komplexer werden.

Sie werden verschiedene Arten von Kommentaren untersuchen, darunter einzeilige und mehrzeilige Kommentare, und verstehen, wie Sie diese effektiv nutzen können, um Code-Logik, Zweck und andere relevante Details zu erklären. Das Lab führt Sie durch das Hinzufügen von Kommentaren zu einem einfachen Python-Skript, um deren Vorteile bei der Verbesserung der Lesbarkeit und Wartbarkeit des Codes zu veranschaulichen.

Zweck von Kommentaren verstehen

In diesem Schritt werden wir den Zweck von Kommentaren in der Programmierung verstehen. Wenn wir Programme schreiben, ist das Hauptziel, dass Maschinen sie ausführen. Wenn jedoch Probleme auftreten, müssen Menschen den Code verstehen, um sie zu beheben. Bei wenigen Codezeilen ist es einfach, die Logik zu erfassen. Aber wenn die Codebasis auf Tausende oder sogar Hunderttausende von Zeilen anwächst, wird das Verständnis des gesamten Programms schwierig. Hier werden Kommentare unerlässlich.

Kommentare sind Notizen im Code, die vom Interpreter oder Compiler ignoriert werden, aber für menschliche Leser wertvoll sind. Sie helfen, die Logik, den Zweck und alle nicht offensichtlichen Details des Codes zu erklären. Das Schreiben guter Kommentare ist entscheidend für die Wartbarkeit des Codes und erleichtert es Ihnen und anderen, den Code in Zukunft zu verstehen und zu ändern.

Betrachten Sie ein einfaches Python-Skript. Ohne Kommentare kann es schwierig sein zu verstehen, was jeder Teil tut, insbesondere für jemanden, der mit dem Code nicht vertraut ist.

Erstellen wir eine einfache Python-Datei namens purpose.py im Verzeichnis ~/project mit dem VS Code-Editor.

Öffnen Sie das integrierte Terminal in VS Code, indem Sie zu Terminal -> New Terminal gehen. Stellen Sie sicher, dass Ihr aktuelles Verzeichnis ~/project ist.

Erstellen Sie nun die Datei purpose.py, indem Sie den folgenden Befehl im Terminal eingeben:

touch purpose.py

Öffnen Sie purpose.py im VS Code-Editor und fügen Sie den folgenden Code hinzu:

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

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

Führen Sie nun das Skript vom Terminal aus:

python purpose.py

Sie sehen die Ausgabe:

30

Dieses einfache Skript addiert zwei Zahlen und gibt das Ergebnis aus. Obwohl es unkompliziert ist, stellen Sie sich vor, dies sei Teil eines viel größeren Programms. Ohne Kommentare ist der Zweck von x, y und z oder warum sie addiert werden, möglicherweise nicht sofort klar.

In den folgenden Schritten lernen wir, wie man verschiedene Arten von Kommentaren hinzufügt, um unseren Code verständlicher zu machen.

Einzeilige Kommentare verwenden

In diesem Schritt lernen wir, wie man einzeilige Kommentare in Python verwendet. Einzeilige Kommentare werden für kurze Erklärungen oder Notizen auf einer einzelnen Zeile verwendet. In Python wird das Hash-Symbol (#) verwendet, um einen einzeiligen Kommentar zu beginnen. Alles nach dem # in dieser Zeile wird als Kommentar betrachtet und vom Python-Interpreter ignoriert.

Einzeilige Kommentare können auf einer eigenen Zeile vor dem Code platziert werden, den sie beschreiben, oder sie können auf derselben Zeile nach dem Code platziert werden.

Lassen Sie uns die Datei purpose.py, die wir im vorherigen Schritt erstellt haben, ändern, um einzeilige Kommentare hinzuzufügen.

Öffnen Sie purpose.py im VS Code-Editor.

Fügen Sie nun Kommentare zum Code hinzu, wie unten gezeigt:

## This script calculates the sum of two numbers

x = 10  ## First number
y = 20  ## Second number
z = x + y  ## Calculate the sum
print(z) ## Print the result

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

Führen Sie nun das geänderte Skript vom Terminal aus:

python purpose.py

Sie sehen dieselbe Ausgabe wie zuvor:

30

Beachten Sie, dass die Kommentare die Ausführung des Codes nicht beeinflusst haben. Sie machen den Code jedoch wesentlich leichter verständlich. Der erste Kommentar erklärt den Gesamtzweck des Skripts, während die Kommentare auf derselben Zeile wie der Code den Zweck jeder Variablen und Operation erklären.

Die effektive Verwendung von einzeiligen Kommentaren kann die Lesbarkeit Ihres Codes erheblich verbessern, insbesondere zur Erklärung einzelner Zeilen oder kleiner Codeblöcke.

Mehrzeilige Kommentare verwenden

In diesem Schritt werden wir untersuchen, wie man mehrzeilige Kommentare in Python schreibt. Während Python keine dedizierte Syntax für mehrzeilige Kommentare wie einige andere Sprachen hat, gibt es gängige Wege, dies zu erreichen.

Eine Möglichkeit besteht darin, mehrere einzeilige Kommentare zu verwenden, die jeweils mit einem Hash-Symbol (#) beginnen. Dies ist der direkteste Ansatz und wird oft zur Klarheit empfohlen.

Erstellen wir eine neue Python-Datei namens multiline.py im Verzeichnis ~/project.

Öffnen Sie das integrierte Terminal in VS Code und stellen Sie sicher, dass Sie sich im Verzeichnis ~/project befinden.

Erstellen Sie die Datei multiline.py:

touch multiline.py

Öffnen Sie multiline.py im VS Code-Editor und fügen Sie den folgenden Code mit mehreren einzeiligen Kommentaren hinzu:

## This is the first line of a multi-line comment.
## This is the second line.
## And this is the third line, explaining the code below.

print("This is a demonstration of multi-line comments.")

Speichern Sie die Datei.

Führen Sie das Skript vom Terminal aus:

python multiline.py

Die Ausgabe wird sein:

This is a demonstration of multi-line comments.

Wie Sie sehen können, werden die Zeilen, die mit # beginnen, ignoriert.

Eine weitere gängige Praxis in Python ist die Verwendung von dreifachen Anführungszeichen ("""...""" oder '''...''') für mehrzeilige Zeichenketten (strings). Obwohl sie hauptsächlich für Docstrings (Dokumentationszeichenketten) verwendet werden, werden diese mehrzeiligen Zeichenketten vom Interpreter ignoriert, wenn sie keiner Variablen zugewiesen sind, und dienen somit effektiv als mehrzeilige Kommentare.

Lassen Sie uns multiline.py ändern, um dreifache Anführungszeichen für einen mehrzeiligen Kommentar zu verwenden.

Öffnen Sie multiline.py im VS Code-Editor und ersetzen Sie den vorhandenen Inhalt durch Folgendes:

"""
This is a multi-line comment using triple double quotes.
It can span multiple lines and is often used for longer explanations.
"""

print("Demonstrating triple quote comments.")

Speichern Sie die Datei.

Führen Sie das Skript erneut aus:

python multiline.py

Die Ausgabe wird sein:

Demonstrating triple quote comments.

Sie können auch dreifache einfache Anführungszeichen ('''...''') verwenden, die genauso funktionieren.

'''
This is another multi-line comment example
using triple single quotes.
Both triple double and single quotes work.
'''

print("Another triple quote example.")

Speichern und führen Sie das Skript aus, um die Ausgabe zu sehen.

Beide Methoden sind für mehrzeilige Kommentare akzeptabel. Die Verwendung mehrerer #-Zeilen wird oft für einfache Kommentare bevorzugt, während dreifache Anführungszeichen häufig für Docstrings am Anfang von Modulen, Klassen oder Funktionen verwendet werden, um detaillierte Dokumentationen bereitzustellen.

Deklarationskommentare hinzufügen

In diesem Schritt lernen wir spezielle Arten von Kommentaren in Python kennen, die als Deklarationskommentare bezeichnet werden. Dies sind einzeilige Kommentare, die vom Python-Interpreter oder dem Betriebssystem auf eine bestimmte Weise erkannt und interpretiert werden. Die beiden Haupttypen sind Kodierungsdeklarationen und Interpreterdeklarationen (Shebang).

Eine Kodierungsdeklaration gibt die Zeichenkodierung der Python-Datei an. Dies ist wichtig, wenn Ihr Code Nicht-ASCII-Zeichen enthält (z. B. Zeichen aus anderen Sprachen). Obwohl Python 3 standardmäßig UTF-8 verwendet, ist es eine gute Praxis, eine Kodierungsdeklaration einzufügen, wenn Sie eine andere Kodierung verwenden oder explizit UTF-8 angeben möchten, insbesondere wenn der Code in Umgebungen mit anderen Standardeinstellungen ausgeführt werden könnte. Die Kodierungsdeklaration muss sich in der ersten oder zweiten Zeile der Datei befinden.

Gängige Formate sind ## coding=utf-8 oder ## -*- coding: utf-8 -*-.

Eine Interpreterdeklaration, auch Shebang-Zeile genannt, ist die allererste Zeile eines Skripts, die dem Betriebssystem mitteilt, welcher Interpreter zur Ausführung des Skripts verwendet werden soll. Dies ermöglicht es Ihnen, das Python-Skript direkt als ausführbare Datei (auf Unix-ähnlichen Systemen) auszuführen, ohne explizit python vor dem Skriptnamen eingeben zu müssen. Die Shebang-Zeile beginnt mit #!, gefolgt vom Pfad zum Interpreter.

Für Python 3 ist eine gängige Shebang-Zeile #!/usr/bin/python3.

Erstellen wir eine neue Python-Datei namens declaration.py im Verzeichnis ~/project und fügen diese Deklarationskommentare hinzu.

Öffnen Sie das integrierte Terminal in VS Code und stellen Sie sicher, dass Sie sich im Verzeichnis ~/project befinden.

Erstellen Sie die Datei declaration.py:

touch declaration.py

Öffnen Sie declaration.py im VS Code-Editor und fügen Sie die folgenden Zeilen ganz am Anfang der Datei hinzu:

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

print("This script has declaration comments.")
print("你好,世界!") ## Example of non-ASCII characters

Speichern Sie die Datei.

Machen wir das Skript nun ausführbar. Führen Sie im Terminal Folgendes aus:

chmod +x declaration.py

Dieser Befehl weist der Datei Ausführungsberechtigungen zu.

Nun können Sie das Skript direkt über das Terminal mit seinem Pfad ausführen:

./declaration.py

Sie sollten die Ausgabe sehen:

This script has declaration comments.
你好,世界!

Die Shebang-Zeile #!/usr/bin/python3 ermöglichte es Ihnen, das Skript direkt auszuführen. Die Kodierungsdeklaration ## -*- coding: utf-8 -*- stellt sicher, dass der Python-Interpreter die Nicht-ASCII-Zeichen in der Zeichenkette "你好,世界!" korrekt interpretiert.

Obwohl die Kodierungsdeklaration in Python 3 aufgrund des standardmäßigen UTF-8 oft optional ist, ist die Shebang-Zeile nützlich, wenn Sie Ihre Python-Skripte auf Unix-ähnlichen Systemen als eigenständige ausführbare Dateien ausführen möchten.

Zusammenfassung

In diesem Lab haben wir zunächst den grundlegenden Zweck von Kommentaren in der Programmierung verstanden und ihre Bedeutung für die menschliche Lesbarkeit und die Wartbarkeit von Code erkannt, insbesondere wenn Codebasen wachsen. Wir haben gelernt, dass Kommentare vom Interpreter ignoriert werden, aber für die Erklärung der Code-Logik und -Absicht von unschätzbarem Wert sind. Anschließend haben wir das Erstellen eines einfachen Python-Skripts geübt und beobachtet, wie die Abwesenheit von Kommentaren selbst grundlegenden Code weniger verständlich machen kann. Dieser erste Schritt legte den Grundstein für die anschließende Erkundung verschiedener Kommentararten und ihrer praktischen Anwendung, um Code verständlicher zu machen.