Kommentare in Python

Variablen in Python - Was ist das, wie erstelle ich Variablen? | Python Grundlagen

Mit Kommentaren kann ich in Python Text in meinen Code schreiben, der aber von Python nicht ausgeführt wird. Das kann ich für verschiedene Dinge nutzen.

  • Um den Code lesbarer zu machen
  • Um den Code zu erklären
  • Um Zeilen auszukommentieren, damit sie nicht ausgeführt werden (besonders hilfreich beim Testen und Debuggen)

In Python verwenden wir für diese Kommentare die Raute (das #-Symbol). Alles was nach dieser Raute steht, ist ein Kommentar.

# Das ist ein Kommentar
print('Dieser Code wird ausgeführt')

In diesem Beispiel wird nur die print()-Funktion ausgeführt, der Text nach der Raute wird von Python beim Ausführen ignoriert. Oft nutzt man diese Kommentare, um Code zu erklären. Vor allem dann, wenn man mit mehreren Personen an einem Projekt arbeitet.

# Die nächste Zeile gibt "Hallo, Python" auf die Konsole aus
print('Hallo, Python')

Das ist natürlich ein triviales Beispiel, aber vor allem bei komplexem Code helfen diese Kommentare oft. Man kann einen Kommentar auch an das Ende einer Zeile schreiben. Das sieht dann so aus.

print('Dieser Code wird ausgeführt') # Alles was hier kommt, ist ein Kommentar

Ein Kommentar muss dabei nicht immer reiner Text sein, oder etwas erklären. Im nächsten Beispiel haben wir drei print()-Funktionen, von denen nur eine ausgeführt wird, weil die anderen beiden aus-kommentiert sind.

print('Dieser Code wird ausgeführt')
# print('Das ist aus-kommentiert')
# print('Auch das wird nicht ausgeführt')
Dieser Code wird ausgeführt

In Python gibt es keine mehrzeiligen Kommentare wie in manchen anderen Programmiersprachen. Wenn man Kommentare in mehrere Zeilen schreiben will, benutzt man normalerweise vor jeder Zeile die Raute, also so:

# Das ist die erste Zeile mit dem Kommentar
# Hier wird der Kommentar fortgesetzt
# Auch das ist noch ein Kommentar

Es gibt einen kleinen Hack mit dem wir trotzdem quasi einen mehrzeiligen Kommentar erstellen können. Wenn wir in Python einen mehrzeiligen String schreiben, aber diesen keiner Variablen zuweisen oder ihn anderweitig verwenden, dann ist das gültiger Code, der aber beim Ausführen ebenfalls ignoriert wird.

'''
Alles was hier steht
ist kein mehrzeiliger Kommentar
aber ein Hack, der auch funktioniert
'''

Obwohl das funktioniert, würde ich empfehlen in der Regel richtige Kommentare zu verwenden. Das vermeidet Verwirrung und sorgt dafür, dass der Code gut lesbar bleibt, da Kommentare in der Regel durch die Syntax-Hervorhebung der verschiedenen IDEs klar vom restlichen Code zu unterscheiden sind.