Python docstring Beispiel
Während die Kommentare für Programme, Aussagen und Ausdrücke verwendet werden, die in der Regel kurz sind, eignen sich DOCStrings hervorragend zum Verständnis der Funktionsweise des größeren Teils des Skripts wie der allgemeinen Verwendung eines Moduls, der Klasse oder der Funktionen. Sie handelt. Es ist entscheidend, Ihren Code ordnungsgemäß zu dokumentieren, wenn Sie Programme mit klarem Code und guter Dokumentation schreiben möchten. Die DocStrings werden mit den „dreifachen einzelnen Zitaten“ oder „dreifachen Doppelzitaten“ direkt nach der Definition der Funktion, Klasse oder Methode verwendet.
Beispiel 1: Programm der Python Docstring Triple Single Quotes
Entweder kann die __DOC__ -Methode des Objekts oder die Hilfsfunktion verwendet werden, um die Docstrings zu erhalten. Die Deklaration und Verwendung eines DocString mit den dreifachen einzelnen Zitaten sind in den folgenden Beispielen angezeigt:
Beginnen Sie mit der Definition einer Funktion in Python. Wir erstellen eine Funktion als my_func (). Im Körper des My_Func haben wir als Docstring um die dreifachen einzelnen Zitate eingewickelt. Am Ende der Funktion führen wir dann ausdrücklich die Return -Anweisung aus, die den Niemandswert zurückgibt. Die Druckfunktion nimmt my_func mit dem _doc_ -Objekt ein, das den Dokument anzeigt. Darüber hinaus haben wir eine Python -Hilfefunktion, mit der die Dokumentation der My_Func -Funktion gedruckt wird.
Wenn dieses spezielle Programm debugiert und ausgeführt wird, generiert es die folgenden Ergebnisse im Konsolenbildschirm von Spyder:
Beispiel 2: Programm von Python Docstring Triple Double Quotes
Im folgenden Code wird die DOCString-Erklärung bereitgestellt und mit den dreifachen Doppelquoten verwendet:
Hier geben wir einen Funktionsnamen my_func2 an. Im Körper des My_Func2 deklarieren wir einen Docstring mit dem Triple-Double-Zitat. Anschließend nennen wir das _doc_ -Objekt des Python, um die angegebene Dokumentation und die Dokumentation der Funktion my_func2 mit der Hilfefunktion zu drucken.
Die aus den oben genannten Codes erzeugten Ergebnisse sind wie folgt. Diese Ausgabe erzeugt durch die Ausführung des vorhergehenden Code in Spyder:
Beispiel 3: Programm von Python One-Line Docstring
One-Line-Docstrings sind genau das, was ihr Name vorschlägt: eine Zeile. Sie sind in offensichtlichen Situationen beschäftigt. Die letzten Zitate befinden sich in einer ähnlichen Linie wie die anfänglichen Zitate. Für Einzeiler scheint dies attraktiver zu sein.
Hier konstruieren wir eine Funktion als „hinzufügen“, die zwei Argumente nimmt: x und y. Anschließend deklarieren wir die One-Line-Docstring im Körper der Funktionsdefinition „Add“. Die Rückgabeanweisung gibt den Wert aus der Zugabe der beiden Werte zurück. Die Druckanweisung wird aufgerufen.
Die Ergebnisse der EinzeilungsdocString sind im folgenden Bildschirm der Spyder-Konsole angezeigt. Diese Ausgabe erzeugt durch die Ausführung des oben angegebenen Code in Spyder:
Beispiel 4: Programm eines Python Multi-Line-Docstring
Ähnlich wie bei den One-Line-Docstrings beginnen die Multi-Line-Docstrings mit einer Zusammenfassungslinie und enden mit einer leeren Linie, bevor sie etwas detaillierter beschreiben. Die Zusammenfassungszeile kann in einer ähnlichen Zeile wie die Anfangszitate oder in einer anderen Zeile angezeigt werden. In der folgenden Instanz wird ein Multiline -Docstring nachgewiesen:
In diesem speziellen Beispielskript haben wir die Funktionsdefinition, die einen Namen als python_function erhält. Diese Funktion nimmt einen Argumentwert x an. Die Funktionsbehörde wird mit der Multi-Line-Zeichenfolge deklariert, die die Beschreibung des Argumentwerts und des Int-Datentyps darstellt. Danach ist der Rückgabebefehl definiert. Der Multiline -Dokument wird angezeigt, indem das Objekt _doc_ in der Druckfunktion aufgerufen wird.
Die Multi-Zeilen des Dokuments werden wie folgt auf dem Spyder-Terminal gedruckt:
Beispiel 5: Programm der Python Docstring -Eindrückung
Die Zitate in seiner Anfangszeile sind in der gleichen Menge wie der Rest des DocString eingerichtet. Jede Eindrücke in der ersten Linie des Docstring (nach der ersten Newline) ist unnötig und sollte beseitigt werden. Danach halten die Linien in der Docstring ihre relative Eindrücke. Schauen wir uns ein Beispiel für ein Beispiel an, um die Docstrings für eine Klasse und ihre Methoden zu erstellen. Der Zugang zum DocString erfolgt durch Hilfe:
Wir definieren eine Klasse mit der Schlüsselwortklasse und nennen diese Klasse als my_python_example. In der Klasse my_python_example deklarieren wir die docstring, die von den dreifachen Doppelquoten umgeben ist. Anschließend erstellen wir das Funktionsquadrat mit der Eingabe x und die Funktion wird auch mit dem Dokument deklariert. Dann erstellen wir eine andere Funktion mit dem Namen, Würfel. Es braucht auch eine Eingabe n. Diese Funktion wird für den Würfel der Zahl erstellt. Diese Erklärung wird durch die Docstring -Erklärung erklärt. Danach haben wir eine Python -Hilfefunktion, um die Dokumentation der My_Python_program -Klasse und des Funktionsquadrats auszuführen.
Aus dem zuvor erwähnten Python -Programm wird die folgende Ausgabe ermittelt. Diese Ausgabe wird durch die Ausführung des zuvor angebotenen Code in Spyder generiert:
Abschluss
Das Hauptziel dieses Kurses ist es, Sie mit den Docstrings vertraut zu machen, indem Sie die grundlegenden Ideen durchlaufen. Da Docstrings jedoch ein so breites Thema ist, ist es möglich, dass einige Ideen übersprungen wurden. Um die Dokumentation einer Funktion zu erhalten, verwenden Sie die Funktion help (). Setzen Sie in der ersten Zeile der Funktion eine Zeichenfolge, entweder eine einzelne Zeichenfolge oder eine Multi-Line-Zeichenfolge, um die Dokumentation hinzuzufügen.