目次
1. Grundlagen des Kommentierens in Python und deren Bedeutung
Das Kommentieren in Python ist ein wichtiges Werkzeug, um den Code für andere oder einen selbst später verständlich zu machen. Durch das Hinzufügen von Erklärungen oder Notizen zum Code verbessert man die Wartbarkeit des Programms, und die Erklärung von Fehlern oder Logik wird reibungsloser. Zudem ist es nützlich, um während der Entwicklung Code temporär zu deaktivieren und zu testen.1.1 Grundlagen des einzeiligen Kommentierens
In Python wird für einzeilige Kommentare „#“ verwendet. Dies behandelt die gesamte Zeile als Kommentar, indem „#“ am Anfang der Zeile platziert wird.# Dies ist ein Kommentar
print("Hello, World!") # Dieser Teil wird auch ein Kommentar
So kann man Erklärungen zum Code oder Kommentare hinzufügen, die bei zukünftigen Änderungen nützlich sind.
1.2 Überblick über mehrzeilige Kommentare
Für mehrzeilige Kommentare ist es üblich, „#“ individuell in mehreren Zeilen zu verwenden. Dies erfordert manuelle Einfügung von „#“ in jede Zeile, ist aber sehr effektiv, um lange Code-Blöcke zu deaktivieren.# Dies ist der Kommentar in der ersten Zeile
# Dies ist der Kommentar in der zweiten Zeile
# Dies ist der Kommentar in der dritten Zeile
Es gibt auch mehrere effiziente Methoden, um den Aufwand für mehrzeilige Kommentare zu reduzieren, die später beschrieben werden.
2. Zwei Methoden zum Kommentieren mehrerer Zeilen in Python
Für das Kommentieren mehrerer Zeilen gibt es mehrere bequeme Techniken. Im Folgenden stelle ich zwei repräsentative Methoden vor.2.1 Mehrzeilige Kommentierung mit „#“
Das Kommentieren mehrerer Zeilen mit „#“ ist die einfachste und gängigste Methode.# Dies ist der Kommentar in der ersten Zeile
# Dies ist der Kommentar in der zweiten Zeile
# Dies ist der Kommentar in der dritten Zeile
Allerdings ist es bei vielen Zeilen zeitaufwendig, daher eignet sich diese Methode für relativ kleine Blöcke.2.2 Mehrzeilige Kommentare mit Triple Quotes
In Python können durch die Verwendung von drei aufeinanderfolgenden einfachen Anführungszeichen (“‘) oder doppelten Anführungszeichen („““) mehrere Zeilen kommentiert werden. Dies wird ursprünglich als Dokumentationsstring (docstring) verwendet, kann aber auch als Alternative zum Kommentieren genutzt werden."""
Hier ist ein mehrzeiliger Kommentar
Kann über mehrere Zeilen deaktiviert werden
"""
Allerdings wird diese Methode als String erkannt, daher ist sie streng genommen kein Kommentar. Sie kann unnötige Ressourcen im Code verbrauchen, weshalb besondere Vorsicht in großen Projekten oder bei wichtiger Speicherverwendung geboten ist.3. Häufige Fehler beim Auskommentieren in Python und Vermeidungsmethoden
Beim Auskommentieren gibt es mehrere Punkte, auf die man achten sollte. Insbesondere bei Fehlern bezüglich der Einrückung und der Verwendung von dreifachen Anführungszeichen muss man vorsichtig sein.3.1 Vermeidung von Einrückungsfehlern
Python hat strenge Regeln für die Einrückung, und wenn der Code nicht richtig eingerückt ist, tritt ein IndentationError auf. Auch beim Auskommentieren mit dreifachen Anführungszeichen kann eine fehlerhafte Einrückung zu unerwarteten Fehlern führen.def example():
"""
Dies ist ein Kommentar
"""
print("Hello, World!") # Dieser Einrückungsfehler tritt auf
Die Ausrichtung der Einrückungen ist in Python sehr wichtig.3.2 Das Problem des Ressourcenverbrauchs durch dreifache Anführungszeichen
Das Auskommentieren mit dreifachen Anführungszeichen wird vom Python-Interpreter als String erkannt und verbraucht daher Speicher. Daher sollte man diese Methode in großen Code-Blöcken nicht übermäßig verwenden. Es ist eine Methode, die eher für Dokumentation als für das Auskommentieren geeignet ist.