Python Kommentare spielen beim Programmieren eine wichtige Rolle. Denn manchmal hat man Probleme, den eigenen Code im Nachhinein zu verstehen. Um das Coden einfacher zu gestalten, sind Kommentare in Python ein sehr nützliches Werkzeug. Doch damit Dein Programm nicht irgendwann als “Codehalde” endet, gibt es im Umgang mit ihnen ein paar Dinge zu beachten.
Was sind Python Kommentare?
Kommentare in Python sind kurze Anmerkungen, die dabei helfen, die Lesbarkeit des Codes zu erleichtern. Dabei werden sie vom Compiler oder Interpreter nicht ausgewertet und haben somit keinen Einfluss auf das Ergebnis. Sie werden bei der Abarbeitung des Programms sozusagen überlesen. Damit das klappt, muss dem Interpreter mitgeteilt werden, dass es sich bei dem besagten Bestandteil um einen Kommentar handelt. In Python macht man das mit einem Rautezeichen (#). Alles, was hinter einem solchen Zeichen steht, wird von Python als Kommentar interpretiert. Klingt auf den ersten Blick ziemlich kompliziert, oder? Am besten schauen wir uns dazu direkt mal ein Beispiel an. Denn so wird Python verständlicher.
# Ich bin ein Kommentar!
Im folgenden Beispiel wurde am Anfang des Codes ein Rautezeichen gesetzt. Die ganze Zeile wird von Python somit als Kommentar erkannt. Aber es gibt noch andere Möglichkeiten, um ein Kommentar in Python zu schreiben. So stellt man sie oftmals hinter den entsprechenden Code.
bestandteile = name.split(“ „) # Trennung von Vor- und Nachname
Zudem kann sich ein Kommentar über mehrere Zeilen erstrecken:
Da es mühsam ist, alle Zeilen von Hand auszukommentieren, besitzt die Python Entwicklungsumgebung eine separate Funktion. Du fragst Dich jetzt mit Sicherheit, wo Du diese Zauberformel findest. Dazu gehst Du in das Menü der Python IDLE und klickst auf den Menüpunkt Format. Anschließend wählst Du das Feld Comment Out Region aus. Die nun aktivierte Funktion zeigt Dir alle Anmerkungen an.
Es gibt noch eine andere Möglichkeit, um Kommentare in Python darzustellen. Als Alternative kann man längere Erläuterungen mit drei Anführungszeichen (“‘) angeben. Die Anführungszeichen stehen dabei zu Beginn und am Ende des Kommentars.
Warum verwendet man Kommentare in Python?
Du fragst Dich mit Sicherheit, warum man überhaupt Kommentare in Python verwenden sollte? Wie schon erwähnt, nutzt man sie, um die Funktionsweise des Codes und dessen Lesbarkeit zu erleichtern. Aber es gibt auch noch andere Gründe, warum man sie verwenden sollte. Der häufigste Grund ist, dass ein Entwickler ein Stück Code nicht ausgeführt haben möchte und diesen deswegen auskommentiert. Oft sieht man das bei Ausgaben, die nur zum Debugging eingebaut wurden. Im folgenden Beispiel summiert ein Entwickler die Zahlen von 1 bis 99. Das Endergebnis wird ausgegeben. Mittendrin findet sich dabei eine auskommentierte Zeile:
Vermutlich hat der unbekannte Entwickler beim Coding zunächst jeden Schleifendurchlauf protokolliert. Später, als er mit dem Ergebnis zufrieden war, hat er die Zeile auskommentiert und nur noch das Endergebnis ausgegeben. Vielleicht hat er gedacht, sie später noch mal gebrauchen zu können. Diese unschöne Verwendung findet man oft. Auch wenn diese Variante von Deinen Programmier-Freunden wahrscheinlich nicht gerne gesehen wird, kann man sie durchaus mal verwenden. Schlimmer wird es, wenn Entwickler alte Versionen ihres Codes in Form von Kommentaren aufbewahren. Im folgenden Beispiel wurde eine frühere Variante des Aufsummierens konserviert:
Das Konservieren eines Codes sollte man unbedingt vermeiden, denn er wird dadurch unleserlich. Als professioneller Programmierer nutzt man Versionsverwaltungen wie zum Beispiel Git, um einen alten Code aufzuheben. Sie ermöglichen Dir, wie in einer Zeitmaschine, verschiedene Stände des Programms zu speichern und bei Bedarf aufzurufen. Du musst also keine weiteren Backups machen. Das mag für den Einsteiger kompliziert klingen, ist aber überaus hilfreich. Denn der Moment wird kommen, indem Du gerne zu einer früheren Version zurückspringen möchtest. Indes geben Versionsmanagement-Systeme eine Menge Sicherheit. Hier solltest Du allerdings nur alte Codes speichern und keine Anmerkungen!
Zweck und Funktion
Nun stellst Du Dir sicher die Frage, wie man ein Kommentar in Python richtig verwendet. Im Optimalfall werden sie benutzt, um anderen Entwicklern zu erläutern, was konkret gemacht wurde. Sie helfen aber auch dabei, den eigenen Code zu verstehen, wenn man diesen nach sehr langer Zeit wiederverwendet. Ein Kommentar kann demnach Auskunft darüber geben, warum etwas gemacht wurde. In der Regel sind das entweder fachliche Zusammenhänge oder sehr komplizierte technische Dinge, an die Kollegen nicht sofort denken würden.
Im folgenden Beispiel werden Reisepreise für eine Agentur berechnet. Im Jahr 2022 feiert die Agentur ihr 75-jähriges Firmenjubiläum. Als besonderes Angebot dürfen Kinder für den halben Preis verreisen. Ein Kommentar dazu könnte wie folgt aussehen:
Am Code erkennt man ganz genau, was gemacht wurde. Doch warum der Code so gestaltet wurde, bleibt unbeantwortet. Wenn in fünf Jahren ein neuer Programmierer den Code liest, wird er ohne einen Kommentar nicht wissen, was damals los war.
Sogenannte To-dos sind ein weiterer guter Grund, um Kommentare in Python zu verwenden. Diese kleinen Anmerkungen weisen darauf hin, dass im Code womöglich noch etwas fehlt. Besser ist es natürlich, diese sofort zu erledigen. Aber manchmal fehlt einem noch eine bestimmte Information. Im Beispiel erinnert das To-do daran, die Rabattaktion wieder zu entfernen:
Sprechende Namen
Selbst korrekt angewandte Kommentare haben ein großes Problem: Sie veralten. Wenn Du den Code überarbeitest, wirst Du dabei den Kommentar irgendwann vergessen. Vielleicht nicht bei jeder Änderung, aber nach und nach. Der Grund dafür ist, dass man den Code ändern muss. Das fällt einem erstmal gar nicht auf, da ein Kommentar den Code nicht beeinflusst. Jedoch kann es im schlimmsten Fall dazu führen, dass ein Kommentar irgendwann total unverständlich ist oder sogar das Gegenteil ausgeführt wird. Das ist die dunkle Seite des Kommentierens in Python.
Doch keine Angst. Es gibt einen Weg, das Dilemma zu umgehen. Indes kannst Du wichtige Informationen in Python Variablen, Funktionen oder Methoden unterbringen. Im Beispiel könnte man den Code hinter dem Kommentar in eine Funktion get_75jahre_jubilaeumspreis() integrieren. Wenn man dann die Variable jahr noch in buchungsjahr umbenennt, ist auch ohne Kommentar alles gesagt. Dieses Vorgehen erfordert allerdings ein wenig Übung. Du musst Dich bei jedem Kommentar im Code immer fragen, ob man das Stück, auf das sich der Kommentar bezieht, nicht auslagern kann. Bis Du soweit bist, sind Kommentare auf jeden Fall die zweitbeste Option. Doch das alles ist kein Grund, um auf sie zu verzichten.
Hast Du alles verstanden? Sehr gut! Dann kannst Du nach dem Python Download sofort mit dem Coden beginnen und das Gelernte direkt anwenden. Du wirst sehen, es ist ganz einfach! Falls Du noch Fragen haben solltest, besuche doch gerne unseren Computerkurs.
Nun hast Du erfahren, wie Kommentare in Python funktionieren und wie man mit ihnen arbeitet. Wenn Du dieses Tutorial weitestgehend verstanden hast, kannst Du nicht nur richtig stolz auf Dich sein, sondern auch das Programmieren wird Dir deutlich leichter fallen. Du hast noch Lust auf mehr? Dann sieh Dir den Artikel zu den Python Dictionaries an!
FAQs – Python Kommentare
Mehrzeile Kommentare in Python zu erstellen ist super leicht. Indes kann man in jeder Zeile ein Rautezeichen setzen. Es gibt aber noch eine weitere Möglichkeit, um einen mehrzeiligen Kommentar zu definieren. Hierfür verwendet man einfach einen multiline-string, welcher mit drei Anführungszeichen (“‘) eingeleitet und beendet wird. Probiere es doch einfach mal aus!
Ein Python Kommentar ist eine kleine Anmerkung, die die Funktionsweise und den Zweck einer bestimmten Stelle im Programmcode beschreibt. Er hilft dabei, Funktionen, Methoden oder Klassen innerhalb eines Blocks besser zu verstehen. Somit behält man beim Coden stets den Überblick. Du möchtest hierzu noch mehr erfahren? Weitere Information hat die Universität Heidelberg übersichtlich zusammengefasst.
In Python stehen zwei Varianten zur Verfügung. So kann man beim Coden einzeilige und mehrzeilige Kommentare verwenden. Letztere werden meist für die Dokumentation benutzt. Sie werden auch Documentation-Strings oder kurz „docstrings“ genannt. Du solltest sie allerdings nur verwenden, wenn sie zum Verständnis des Quelltextes beitragen. Denn ansonsten wird Dein Code sehr unübersichtlich.
