Kommentare sind beim Programmieren eine nützliche Sache. Man kann seinem Code Kommentare hinzufügen, um die einzelnen Schritte für sich und andere verständlicher zu machen. Kommentare in Python musst du kennen, um besseren Code zu schreiben.
Funktioniert irgendetwas mit dem Code nicht, dann kann man einzelne Zeilen in Kommentare umwandeln. Das nennt man auskommentieren. Dadurch werden diese vom Compiler oder Interpreter beim Ausführen des Codes ignoriert. So kann man Fehler im Code finden. Um Kommentare in Python zu nutzen, gibt es mehrere Alternativen, die ich dir in diesem Beitrag zeigen möchte.
Möglichkeit 1: Kommentare in Python mit # markieren
Einzelne Zeilen lassen sich mit der Raute # auskommentieren. Du kannst das Zeichen # vor eine ganze Zeile setzen oder nur vor einen bestimmten Teil einer Zeile.
Im vorherigen Bild wurde durch eine Raute # ein Kommentar hinzugefügt. Damit wurde der Sinn der Codezeile erklärt. Das kann hilfreich sein für denjenigen, der den Code schreibt, aber auch für andere Leute, die den Code lesen.
Man kann also eine ganze Zeile auskommentieren, indem man # an den Anfang der Zeile setzt oder nur einen Teil der Zeile, wie im vorherigen Bild.
Möglichkeit 2: Kommentare in Python über mehrere Zeilen
Eine weitere Methode Kommentare in Python einzufügen ist die Verwendung von drei Anführungsstrichen “ “ „.
Das ist sehr nützlich, da man damit mehrere Zeilen auskommentieren kann. Sprich, du erstellst mehrzeilige Kommentare.
In diesem Bild siehst du, dass ich den Sinn der for-Schleife durch einen Kommentar gekennzeichnet habe.
Die drei Anführungszeichen “ “ “ leiten den Kommentar ein und am Ende des Kommentars beende ich den Kommentar erneut mit “ “ „.
Insgesamt erstreckt sich der Kommentar über mehrere, in dem Fall zwei, Zeilen.
Zeilen in Python auskommentieren, um Fehler im Code finden
Ein großer Nutzen der Kommentare in Python und anderen Programmiersprachen ist es, Fehler im Code aufzudecken. Wenn irgendwas schiefläuft, dann kann man einzelne Zeilen oder Blöcke auskommentieren. Diese werden dann ignoriert.
Wenn der Code durchläuft ohne die ein oder andere Zeile zu beachten, dann weißt du das genau in diesen Zeilen dein Fehler liegen muss.
Dies ist eine Methode, die jeder Programmier-Anfänger von Anfang an verwenden sollte. Wenn etwas nicht läuft, erstmal Codestücke auskommentieren. Nicht einfach löschen und neu schreiben.
Man kann total viel lernen, wenn man seine Fehler findet und darüber nachdenkt. Außerdem ist man sehr viel schneller frustriert, wenn man alles immer wieder neu macht und nicht weiß, wo genau der Fehler liegt.
Richtig Kommentieren nach PEP8-Richtlinie
Es gibt ein Dokument, das Richtlinien vorgibt, um guten Pythoncode zu schreiben. Dieses nennt sich PEP8, kurz für Python Enterprise Proposal. Darin enthalten sind Richtlinien, an die sich Programmierer halten, damit der Pythoncode lesbar und leicht verständlich ist.
Wenn sich alle an die gleichen Regeln halten, dann lässt sich natürlich ein Programm von vielen Menschen auch schneller verstehen.
PEP8 wurde von dem Entwickler von Python, Guido van Rossum, und Barry Warsaw und Nick Coghlan im Jahr 2001 verfasst.
Über Inline-Kommentare steht dort folgende Regeln.
Vor dem Rautenzeichen # zwei Leerzeichen und danach eines.
Außerdem beginnen die Kommentare mit einem Großbuchstaben.
Ich habe dir hier ein Bild gemacht, um das zu verdeutlichen.
Natürlich ist es nicht „falsch“, wenn du weniger Leerzeichen lässt. Aber es ist immer gut, wenn sich alle an die gleichen Richtlinien halten, damit der Code übersichtlich, logisch und gut lesbar geschrieben ist.
Kommentare in Python – fortgeschrittene Methode
Du kannst auch alle die Zeilen, die du in einen Kommentar umwandeln willst, in einen if-Block einfügen. Das siehst du im nächsten Bild.
Alles was nach if False: eingerückt an Code steht wird ignoriert. Das liegt daran, dass der Fall False nicht eintritt. Wir haben keine Bedingung dafür definiert.
Das ist logisch ein etwas schwierigeres Konzept. Zudem ist es etwas nervig alle Zeilen, die zum Kommentar werden sollen, einzurücken, wenn dein Editor das nicht automatisch macht.
Eine ähnliche Möglichkeit wäre, einen if-Block mit if None: zu beginnen.
Natürlich gibt es auch noch Shortcuts, diese sind von Editor zu Editor verschieden. Welche IDE/Editor verwendest du für das Programmieren mit Python? Lass gerne ein Kommentar da.
Zusammenfassung
Es gibt zwei wichtige Methoden, um Kommentare in Python zu implementieren.
- Schreibe # vor die Zeile, oder vor den Teil der Zeile der zu einem Kommentar werden soll,
- Verwende “ “ “ Anführungsstriche hintereinander vor und nach deinem Kommentar, um mehrzeilige Kommentare in Python zu erstellen.
Schreib einen Kommentar, ob dierser Beitrag für dich hilfreich war und, ob er deine Fragen beantwprten konnte.