In diesem Tutorial lernen wir anhand von Beispielen, Kommentare in Python zu erstellen.
Video: Kommentare in Python
Kommentare sind Beschreibungen, die Programmierern helfen, die Absicht und Funktionalität des Programms besser zu verstehen.
Sie werden vom Python-Interpreter vollständig ignoriert.
Vorteile der Verwendung von Kommentaren
Die Verwendung von Kommentaren in Programmen macht unseren Code verständlicher. Dadurch wird das Programm besser lesbar, sodass wir uns daran erinnern können, warum bestimmte Codeblöcke geschrieben wurden.
Abgesehen davon können Kommentare auch verwendet werden, um Code zu ignorieren, während andere Codeblöcke getestet werden. Dies bietet eine einfache Möglichkeit, die Ausführung einiger Zeilen zu verhindern oder einen schnellen Pseudocode für das Programm zu schreiben.
Einzeilige Kommentare in Python
In Python verwenden wir das Hash-Symbol #, um einen einzeiligen Kommentar zu schreiben.
Beispiel 1: Einzeilige Kommentare schreiben
# printing a string print('Hello world')
Ausgabe
Hallo Welt
Hier lautet der Kommentar:
# printing a string
Diese Zeile wird vom Python-Interpreter ignoriert.
Alles, was danach kommt, #wird ignoriert. Wir können das obige Programm also auch in einer einzigen Zeile schreiben als:
print('Hello world') #printing a string
Die Ausgabe dieses Programms ist dieselbe wie in Beispiel 1 . Der Interpreter ignoriert den gesamten Text danach #.
Mehrzeilige Kommentare in Python
Python bietet keine separate Möglichkeit, mehrzeilige Kommentare zu schreiben. Es gibt jedoch andere Möglichkeiten, um dieses Problem zu umgehen.
Wir können #am Anfang jeder Kommentarzeile mehrere Zeilen verwenden.
Beispiel 2: Verwenden mehrerer #
# it is a # multiline # comment
Hier wird jede Zeile als einzelner Kommentar behandelt und alle werden ignoriert.
String-Literale für mehrzeilige Kommentare
Obwohl es in Python keine eindeutige Möglichkeit gibt, mehrzeilige Kommentare zu schreiben, wissen wir, dass der Python-Interpreter die Zeichenfolgenliterale ignoriert, die keiner Variablen zugewiesen sind.
Wir können also sogar einen einzeiligen Kommentar schreiben als:
#this is a comment 'this is an unassigned string as a comment '
Hier sehen wir, dass die zweite Zeile des Programms eine Zeichenfolge ist, aber keiner Variablen oder Funktion zugewiesen ist. Der Interpreter ignoriert also die Zeichenfolge.
In ähnlicher Weise können wir mehrzeilige Zeichenfolgen (dreifache Anführungszeichen) verwenden, um mehrzeilige Kommentare zu schreiben.
Das Anführungszeichen kann entweder 'oder sein ".
Beispiel 3: Verwenden von String-Literalen zum Schreiben mehrzeiliger Kommentare
''' I am a multiline comment! ''' print("Hello World")
Hier wird die mehrzeilige Zeichenfolge keiner Variablen zugewiesen, sodass sie vom Interpreter ignoriert wird. Obwohl es sich technisch gesehen nicht um einen mehrzeiligen Kommentar handelt, kann er als einer verwendet werden.
Python-Dokumentzeichenfolgen
Konventionell sind die dreifachen Anführungszeichen, die direkt nach der Funktions-, Methoden- oder Klassendefinition angezeigt werden, Dokumentzeichenfolgen (Dokumentationszeichenfolgen).
Dokumentzeichenfolgen sind Objekten zugeordnet und können über das __doc__Attribut aufgerufen werden .
Weitere Informationen finden Sie unter Python docstrings.
Wie schreibe ich bessere Kommentare?
- Verwenden Sie Kommentare, um zu beschreiben, was eine Funktion tut, und nicht die spezifischen Details, wie die Funktion dies tut.
- Versuchen Sie, so viele redundante Kommentare wie möglich zu entfernen. Versuchen Sie, Code zu schreiben, der sich selbst erklären kann, indem Sie eine bessere Wahl des Funktions- / Variablennamens verwenden.
- Versuchen Sie, die Kommentare so kurz und prägnant wie möglich zu gestalten.
