docstring, Seitenzahl 1

Ein Docstring ist eine Zeichenfolge, die als erste Anweisung in einer Modul-, Funktions-, Klassen- oder Methodendefinition auftritt und zum Dokumentieren des Objekts verwendet wird, in dem sie auftritt.

Antworten

Wie dokumentiert man Strukturen in Python?

Wenn erwartet wird, dass ein Argument für eine Funktion eine bestimmte (oder äquivalente) Struktur ist, die mit list , tuple und dict von python, wie und wo sollte es dokumentiert werden? Ein Beispiel Dokumentation : %Vor% Ei...

07.02.2013, 17:39

Antwort

So geben Sie DocString für init in der Python C-Erweiterung an

Vielleicht eine dumme Frage: Wie kann man DocString für spezielle Funktionen wie __init__ beim Schreiben einer C-Erweiterung angeben? Für gewöhnliche Methoden enthält die Methodentabelle Bestimmungen für Docstrings. Die folgende automatisch g...

11.08.2012, 09:27

Antwort

Zeigen Sie reStructuredText (Sphinx) DocStrings in iPython an?

Gibt es eine Möglichkeit, dass IPython die DocStrings reStructuredText (für Sphinx) vollständig rendert, wenn Sie Folgendes eingeben: %Vor% oder: %Vor% Ich finde es super ablenkend, um zu versuchen, Hilfedokumente in IPython zu lesen,...

24.01.2012, 20:45

Antworten

Docstrings - eine Zeile vs. mehrere Zeilen

Ich füge eine ( epydoc ) Dokumentation zu einem Paket hinzu, das ich geschrieben habe, und ich bin es auch Ich begegne vielen Fällen, in denen ich mich viele Male wiederhole. %Vor% PEP257 sagt Folgendes: One-Liner sind für wirklich o...

22.02.2012, 09:25

Antworten

Wie kann ich Python / Sphinx Dokumentobjektattribute nur in init deklarieren?

Ich habe Python-Klassen mit Objektattributen, die nur als Teil der Ausführung des Konstruktors deklariert sind: %Vor% Wenn ich jetzt entweder help(Foo) verwende oder versuche, Foo in Sphinx zu dokumentieren, werden die Attribute self....

18.10.2010, 13:25

Antwort

Make-Funktion haben Ellipsen für Argumente in der Hilfe () -Funktion

Wenn Sie help(vars) eingeben, wird Folgendes erzeugt: %Vor% Wenn ich Folgendes mache: %Vor% zeigt dies an: %Vor% Wie kann ich es so ändern, dass es zwischen den Klammern mit ... angezeigt wird wie die eingebaute Funktion vars(...

27.02.2016, 02:53

Antworten

Sollte der Docstring nur die Ausnahmen enthalten, die explizit von einer Funktion ausgelöst werden?

Beim Schreiben von Doc-Strings in Python frage ich mich, ob der Docstring die Exceptions enthalten soll, die implizit ausgelöst werden oder ob er auch die Exceptions enthalten soll, die ich explizit aufrufe. Betrachten Sie die Funktion %Vor...

21.10.2015, 15:08

Antwort

Kann ich die Dokumentationszeichenfolge einer Funktion in Python mit VIM anzeigen?

Gibt es eine Möglichkeit, die Doc-Zeichenfolge einer Funktion beim Schreiben von Python in VIM anzuzeigen? Zum Beispiel: %Vor% Ich möchte MyFunction(spam0) eingeben und die Doc-Zeichenfolge entweder als QuickInfo oder in der Statusleis...

08.07.2009, 08:50