Kommentare in Python nutzen
Kommentare in Programmen können für unterschiedliche Zwecke genutzt werden. Dazu gehören die typischen 3 folgende Varianten:
- erklärende Kommentare innerhalb vom Code
- bessere Lesbarkeit des Codes
- zum Testen von Code, bzw. zum Verhindern der Ausführung auskommentierter Programmteile
erklärende Kommentare
Wird ein Programm komplexer und man betreut es über Jahre bzw. mehrere Personen arbeiten an einer Software, ist es hilfreich, Codeabschnitte zu kommentieren. Dadurch ist auch noch Jahre später schnell klar, warum etwas an einer bestimmten Stelle in der entsprechenden Art umgesetzt wurde.
Auch beim Programmieren in Teams können Kommentare weiterhelfen.
Als Einsteiger wird man aber eher von der folgenden Art profitieren:
bessere Lesbarkeit von Code
Der Quellcode kann durch Kommentare entsprechend besser Lesbar gemacht werden. Python zwingt durch das Einrücken bereits zu sehr sauberem Code. Allerdings kann je nach Anwendung ein Kommentar die Lesbarkeit weiter verbessern.
auskommentieren zum Testen von Code
Funktioniert einmal ein Programmteil nicht wie gewünscht, kann schnell einmal zum Testen bestehender Code auskommentiert werden und Testcode eingefügt werden. Auskommentierter Code kann nach Auffinden des Fehlers wieder schnell aktiviert werden. Das hat gegen löschen den großen Vorteil, dass alles wieder vorhanden ist und nichts versehentlich vergessen wird.
Möglichkeiten zum Kommentieren/Auskommentieren
Kommentare starten mit einer Raute. Alles nach dem Doppelkreuz „#“ wird von Python ignoriert.
Beispiel:
# hier kommt ein Kommentar
print("Hallo Welt")
Die Kommentare können auch nach Befehlen platziert werden. Ab dem Doppelkreuz „#“ wird alles ignoriert!
print("Hallo Welt") # hier kommt ein Kommentar
Soll ein Code auskommentiert („ausgeschaltet“) werden, wird das Doppelkreuz einfach am Anfang der Zeile platziert:
# print("Hallo")
print("Welt")
Als Ergebnis erhalten wir nur noch als Ausgabe das Wort „Welt“. Die Zeile mit der Ausgabe für „Hallo“ wird durch das Kommentarzeichen komplett ignoriert.
Kommentare über mehrere Zeilen
Meistens möchte man nicht nur eine Zeile Code auskommentieren und möchte auch nicht vor jeder einzelnen Programmzeile ein Doppelkreuz platzieren. Dann bietet sich die Möglichkeit an, mehrere Zeilen auf einen Schlag auszukommentieren.
Dies geschieht über 3 doppelte Anführungszeichen:
"""
Hier kommt auskommentierter Bereich
der über mehrere Zeilen sich zieht
"""
Am Ende kommen dann wieder 3 doppelte Anführungszeichen. Ab jetzt werden wieder alle Python-Befehle ausgeführt.
Dieses Vorgehen kann man sowohl zum Platzieren von umfangreichen Kommentaren nutzen wie auch um ganze Programmteile auszukommentieren:
"""
print("Hallo")
print("Welt")
"""
