In diesem Artikel werden wir uns mit dem Konzept mehrzeiliger Kommentare in Python befassen und eine umfassende Definition zusammen mit anschaulichen Beispielen in der Programmiersprache Python zum Kommentieren mehrerer Zeilen in bereitstellen Python .
Was ist ein mehrzeiliger Kommentar in Python?
Mehrzeilige Kommentare in Python beziehen sich auf einen Textblock oder Anweisungen, die zu Erläuterungs- oder Dokumentationszwecken im Code verwendet werden. Im Gegensatz zu einzeiligen Kommentaren, die durch das Rautesymbol (#) gekennzeichnet sind, werden mehrzeilige Kommentare in dreifache doppelte Anführungszeichen (``) oder dreifache einfache Anführungszeichen (`’`) eingeschlossen. Diese Kommentare werden häufig verwendet, um detaillierte Erklärungen, Dokumentationen oder Notizen zum Code bereitzustellen, und sie können sich über mehrere Zeilen erstrecken. Während Python keine spezielle Syntax für mehrzeilige Kommentare hat, erzielt die Verwendung von dreifachen Anführungszeichen einen ähnlichen Effekt, da der Interpreter den eingeschlossenen Text ignoriert.
Arten von mehrzeiligen Kommentaren in Python
Es gibt zwei Möglichkeiten, wie wir unserem Code mehrzeilige Python-Kommentare hinzufügen können. Sie sind wie folgt:
- Aufeinanderfolgender einzeiliger Kommentar
- Verwenden einer mehrzeiligen Zeichenfolge als Kommentar
- Verwendung der Backslash-Methode
Kommentieren Sie mehrere Zeilen in Python mit aufeinanderfolgenden einzeiligen Kommentaren aus
In Python , das Hash-Zeichen (#) wird zum Kommentieren der Zeile verwendet. Einzelne Zeile Kommentare in Python Sie müssen nicht nur Text sein, um den Code zu erklären, sondern können auch verwendet werden, um zu verhindern, dass Python Code ausführt. Das Hash-Zeichen sollte vor jeder Zeile platziert werden, damit es in Python als mehrzeiliger Kommentar betrachtet wird.
Beispiel: Aufeinanderfolgender einzeiliger Kommentar
Hier enthalten die ersten beiden Zeilen ein Hash-Zeichen (#) und der Interpreter verhindert die Ausführung der beiden Zeilen. Dann werden die Python-Kommentare ausgegeben und schließlich wird die Ausführung der letzten Zeile verhindert.
Datenstrukturen in JavaPython3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')> Ausgabe:
Python Comments>
Kommentieren Sie mehrere Zeilen in Python aus, indem Sie eine mehrzeilige Zeichenfolge als Kommentar verwenden
Mehrzeilige Python-Kommentare können auch in ein Trennzeichen () eingeschlossen werden. Auch hier sollte zwischen den Trennzeichen () kein Leerraum stehen. Sie sind nützlich, wenn der Kommentartext nicht in eine Zeile passt und sich daher über mehrere Zeilen erstrecken muss. Diese Art von Zeichenfolgenliteral wird ignoriert, da sie keiner Variablen zugewiesen ist. Wir können mit __doc__ auf diese Zeichenfolgen zugreifen.
Beispiel: Verwendung einer mehrzeiligen Zeichenfolge als Kommentar
Mehrzeilige Kommentare werden verwendet, um mehr als eine Zeile zu kommentieren. Die erste Zeile ist ein einzeiliger Kommentar. Die zweite und dritte Zeile können mit dreifachen Anführungszeichen() kommentiert werden. Dies verhindert die Ausführung des obigen Codes. Schließlich wird Mathematik in der Ausgabe ausgegeben. Wenn diese mehrzeiligen Python-Kommentare jedoch direkt nach einer Funktions- oder Klassensignatur platziert werden, werden diese zu Dokumentzeichenfolgen .
Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')> Ausgabe:
Mathematics>
Kommentieren Sie mehrere Zeilen in Python mit der Backslash-Methode aus
Eine Methode zum Erstellen mehrzeiliger Kommentare in Python besteht darin, den Backslash („“) am Ende jeder Zeile zu verwenden, um die Zeilenfortsetzungsfunktion zu nutzen und so zu ermöglichen, dass der Kommentar bis zur nächsten Zeile verlängert wird. Diese Zeilenfortsetzungsmethode ist weniger verbreitet als andere Ansätze wie aufeinanderfolgende einzeilige Kommentare oder mehrzeilige Zeichenfolgen und wird hauptsächlich aus Gründen der Codelesbarkeit verwendet, wenn es erforderlich ist, einen Kommentar über mehrere Zeilen aufzuteilen.
Beispiel : In diesem Beispiel beginnen die Kommentare mit#>werden mithilfe des Backslashs () auf mehrere Zeilen erweitert.>) am Ende jeder Zeile. Der Backslash gibt an, dass der Kommentar in der nächsten Zeile fortgesetzt wird. Diese Methode kann hilfreich sein, um die Lesbarkeit des Codes zu verbessern, wenn Sie längere Kommentare haben.
# Using backslash for multiline comments # This is a long comment # that spans multiple lines # using the backslash continuation method. # Code continues below print('Hello, World!')> Ausgabe :
Hello, World!>
Docstrings in Python
Der Dokumentzeichenfolge ist eine integrierte Funktion von Python, die verwendet wird, um geschriebene Dokumentation mit Python-Modulen, -Funktionen, -Klassen und -Methoden zu verknüpfen. Es wird direkt unter den Funktionen, Modulen oder Klassen hinzugefügt, um zu beschreiben, was sie tun. In Python wird der Docstring dann über bereitgestellt Python __doc__ Attribut.
Beispiel: Docstrings in Python
In diesem Beispiel haben wir nach der Definition der Funktion multiply() einen Docstring-Kommentar mit dreifachen Anführungszeichen deklariert. Dann drucken wir die Dokumentzeichenfolge mit dem Attribut __doc__.
Python3 def multiply(a, b): '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>
Ausgabe:
Multiplies the value of a and b>
Unterschied zwischen Kommentaren und Docstring in Python
Sehen wir uns den Unterschied zwischen Python-Kommentaren und Docstring an:
Binärbaum Java
Kommentare | Dokumentzeichenfolgen |
|---|---|
| Sie werden mit # deklariert | Sie werden mit deklariert |
| Wird verwendet, um die Lesbarkeit des Codes zu erhöhen | Gibt eine Beschreibung der Python-Module, -Funktionen und -Klassen |
| Auf sie kann nicht zugegriffen werden | Sie können über __doc__ aufgerufen werden. |