Python: Kommentare
PCEP-30-02 1.2 – Comments
Im Kurs Pseudocode und Dokumentation → Kommentare haben wir bereits gelernt, wofür wir einzeilige und mehrzeilige Kommentare nutzen können.
Einzeilige Kommentare
Einfache, einzeilige Kommentare in Python werden mit einem Hashtag (#) eingeleitet. Alles was nach einem Hashtag geschrieben wird, wird nicht vom Compiler interpretiert:
# Python-Code:
# Das ist ein einzeiliger Kommentar
1. Einzelne Zeile beschreiben:
Wir verwenden häufig einzeilige Kommentare, um eine einzelne Codezeile oder Variable zu beschreiben:
# Python-Code:
print("Das hier wird ausgeführt") # Hier wird "Das hier wird ausgeführt" in die Kommandozeile geschrieben
x = 6 # Dieser Variable "x" weise ich den Wert 6 zu
Ausgabe in der Konsole:
Das hier wird ausgeführt
2. (Kleinere) Codeblöcke
Oder um kurze Code-Schnipsel zu beschreiben oder als Erkennungsmarke vor Anweisungen:
# Python-Code:
# Der Code danach wird ausgeführt
print("Das hier wird ausgeführt")
print("Das hier wird auch ausgeführt")
# Wenn die Anweisung zutrifft dann ...
if True:
print("... schreibe das hier in die Konsole")
# Trifft die Anweisung aber nicht zu, dann ...
else:
print("... schreibe etwas anderes in die Konsole")
Ausgabe in der Konsole:
Das hier wird ausgeführt
Das hier wird auch ausgeführt
... schreibe das hier in die Konsole
3. Auskommentierung von Programmcode
Wir können auch Code temporär auskommentieren, wenn wir etwas testen möchten:
# Python-Code:
# Diesen Code habe ich auskommentiert, um etwas zu testen:
# print("Das hier wird nicht ausgeführt")
print("Das hier wird aber ausgeführt")
Ausgabe in der Konsole:
Das hier wird aber ausgeführt
Mehrzeilige Kommentare
Mehrzeilige Kommentare werden häufig dazu verwendet, um Code-Blöcke wie Funktionen zu kommentieren, die wir uns später noch genauer ansehen. Wenn man es sehr genau nimmt, gibt es in Python keine offizielle Möglichkeit, mehrzeilige Kommentare zu definieren. Der Weg wäre, jede Zeile mit einem Hashtag # zu beginnen.
Es gibt aber einen Trick:
Wenn du mehrzeilige Kommentare verwenden möchtest, kannst du das mit einleitend drei Gänsefüßchen „““ und schließend mit drei Gänsefüßchen machen. Wir sprechen hierbei von sogenannten Docstrings:
# Python-Code:
"""
Ein mehrzeiliger Kommentar mit Gänsefüßchen
für mein zertifiziertes Python-Tutorial
Author: Roland Milto
Version: 2025-03-05
"""
print("Das hier ist ein wirklich wichtiger, sehr langer Code")
Ausgabe in der Konsole:
Das hier ist ein wirklich wichtiger, sehr langer Code
Hierbei handelt es sich eigentlich um mehrzeilige Zeichenketten/ Sätze (genannt Docstrings), mit denen wir uns noch genauer beschäftigen werden. Der Code wird so zwar gelesen, aber nicht ausgegeben. Damit mehrzeilige Zeichenketten aber ausgegeben werden können, müsste das beispielsweise mit print() ausgegeben werden.
So wird eine mehrzeilige Ausgabe in der Konsole ausgegeben:
# Python-Code:
print("""
Ein mehrzeiliger Kommentar mit Gänsefüßchen
für mein zertifiziertes Python-Tutorial
Author: Roland Milto
Version: 2025-03-05
""")
print("Das hier ist ein wirklich wichtiger, sehr langer Code")
Ausgabe in der Konsole:
Ein mehrzeiliger Kommentar mit Gänsefüßchen
für mein zertifiziertes Python-Tutorial
Author: Roland Milto
Version: 2025-03-05
Das hier ist ein wirklich wichtiger, sehr langer Code
Dieser Code hingegen wird einen Fehler in der Konsole verursachen, wenn wir nur ein Gänsefüßchen am Anfang und Ende verwenden:
# Fehlerhafter Python-Code:
print("
Weil wir hier nur
mit einem Gänsefüßchen
arbeiten, führt das
zu einem Fehler, weil
es in Python nicht
erlaubt ist!
")
Double vs. Single Quotes
Es können statt Gänsefüßchen („), genannt Double Quotes auch einfache Aphostrope (‚), genannt Single Quotes verwendet werden:
# Python-Code:
'''
Ein mehrzeiliger Kommentar mit Aphostrophen
für mein zertifiziertes Python-Tutorial
Author: Roland Milto
Version: 2025-03-05
'''
print("Das hier ist ein wirklich wichtiger, sehr langer Code")
Es macht keinen Unterschied, ob die eine oder andere Variante verwendet wird. Es kann jedoch vorkommen, dass die Umwicklungsumgebung mit der man arbeitet, diese Docstrings unterschiedlich formatiert oder farblich darstellt.
In diesem Kurs werden wir die Variante mit den Gänsefüßchen verwenden, da es sich generell um die empfohlene Schreibweise handelt.
Wichtig ist lediglich, dass die letzten drei Double Quotes in einer Zeile stehen sollten gemäß dem Style Guide for Python nach PEP 8 und der Docstring Convention PEP 257. Dabei ist es in Ordnung bei den ersten Double Quotes, direkt dahinter oder in einer neuen Zeile anzufangen.