Option 2: Verwenden von mehrzeiligen Zeichenfolgen als Kommentare
Eine weitere Option zum Schreiben von“ richtigen“mehrzeiligen Kommentaren in Python besteht darin, mehrzeilige Zeichenfolgen mit der """
Syntax auf kreative Weise zu verwenden. Hier ist ein Beispiel:
"""This is a "block comment" in Python, madeout of a mult-line string constant.This actually works quite well!"""answer = 42
Wie Sie sehen, können Sie dreifach zitierte Zeichenfolgen verwenden, um etwas zu erstellen, das einem mehrzeiligen Kommentar in Python ähnelt., Sie müssen nur sicherstellen, dass Sie die erste """
korrekt einrücken, andernfalls erhalten Sie eine SyntaxError
. Wenn Sie beispielsweise einen Blockkommentar innerhalb einer Funktion mit dieser Technik definieren möchten, müssen Sie dies folgendermaßen tun:
Denken Sie daran, dass diese Technik keine „echten“ Kommentare erstellt. Dadurch wird einfach eine Textkonstante eingefügt, die nichts bewirkt. Es ist dasselbe wie das Einfügen einer regulären einzeiligen Zeichenfolge irgendwo in Ihren Code und niemals den Zugriff darauf.,
Eine solche verwaiste String-Konstante wird jedoch nicht im Bytecode angezeigt, wodurch sie effektiv in einen mehrzeiligen Kommentar umgewandelt wird. Hier ist ein Beweis dafür, dass die nicht verwendete Zeichenfolge nicht in der CPython-Bytecode-Disassemblierung angezeigt wird:
Seien Sie jedoch vorsichtig, wo Sie diese „Kommentare“ im Code platzieren., Wenn die Zeichenfolge direkt nach einer Funktionssignatur, einer Klassendefinition oder am Anfang eines Moduls folgt, wird sie zu einem Docstring, der in Python insgesamt eine andere Bedeutung hat:
Docstrings („Dokumentationszeichenfolgen“) können Sie Python-Modulen, Funktionen, Klassen und Methoden eine lesbare Dokumentation zuordnen. Sie unterscheiden sich von Quellcode-Kommentaren:
Ein Kommentar wird vom Parser entfernt, während ein docstring im Bytecode landet und dem dokumentierten Objekt zugeordnet ist. Es kann sogar programmgesteuert zur Laufzeit zugegriffen werden.,
Wie ich bereits sagte, besteht die einzige Möglichkeit, „echte“ mehrzeilige Kommentare in Python zu erhalten, die vom Parser ignoriert werden, darin, mehrere #
einzeilige Kommentare zu verwenden.
Ich gebe zu, dass ich etwas überrascht war, dass dieser“ gefälschte “ Blockkommentarstil von Guido van Rossum, dem Schöpfer von Python, unterstützt wurde: