Suchergebnisse für Anfrage "docstring"

1 die antwort

Wie verhindere ich, dass PyCharm Docstrings auffüllt?

Wenn ich einer Methode mit dem dreifachen Anführungszeichen einen Docstring hinzufüge, füllt PyCharm den Docstring mit den Parametern der Methode und einem Rückgabewert wie folgt: def fill_blank(self, direction): """ :param direction: :return: ...

1 die antwort

Was ist der Vorteil von mehrzeiligen und einzeiligen String-Literalen in Python?

Ich weiß, dass die dreifach zitierten Zeichenfolgen als Dokumentzeichenfolgen verwendet werden, aber müssen wirklich zwei Zeichenfolgenliterale vorhanden sei...

1 die antwort

Welche Bedeutung haben diese Formate in der Dokumentenkette von twisted?

Im Quellcode von twisted enthalten viele Dokumentzeichenfolgen folgende Formate: L {xxx} oder C {xxx} oder eine Zeile, die mit einem '@' beginnt. Wel...

TOP-Veröffentlichungen

5 die antwort

Mehr als 1 Dokumentzeichenfolgen für ein einzelnes Modul / eine einzelne Funktion usw.?

Ich benutze Python 3.1. Ist es möglich, mehr als eine Dokumentzeichenfolge für ein einzelnes Modul oder eine einzelne Funktion zu erstellen? Ich erstelle ein Programm und beabsichtige, mehrere Dokumentzeichenfolgen mit einer Kategorie für jede ...

1 die antwort

Dokumentieren des Rückgabetyps "Tupel" in einem Funktionsdokumentstring für Hinweise auf PyCharm-Typen

Wie kann ich dokumentieren, dass eine Funktion a zurückgibt?

4 die antwort

Ersetzen von Python-Docstrings [geschlossen]

Ich habe ein geschriebenepytext [http://epydoc.sourceforge.net/epytext.html]zu sich ausruhen [http://docutils.sourceforge.net/docs/user/rst/quickref.html] markup converter, und jetzt möchte ich alle docstrings in meiner gesamten bibliothek von ...

1 die antwort

Verweisen auf Parameter in einer Python-Dokumentzeichenfolge

Ich benutze Sphinx und die Autodocs-Funktion, um sicherzustellen, dass wir gute Dokumente in unserem Projekt haben.Also bin ich vertraut mitInfofeldlisten un...

2 die antwort

Warum Python-Docstring anders als Kommentar interpretiert wird

Nehmen wir an, ich habe eine Funktion wie diese: def myFunc(): # useful function to calculate stuffDies führt zu einem Einrückungsfehler, sofern ich nichts hinzufügepass: def myFunc(): # useful function to calculate stuff passWenn ich jedoch ...

3 die antwort

Dreifach-Doppel-Anführungszeichen vs. Doppelte Anführungszeichen

Was ist die bevorzugte Methode zum Schreiben eines Python-Dokumentstrings?

4 die antwort

Wie verweise ich mit Sphinx-Markup auf einen dokumentierten Python-Funktionsparameter?

Ich möchte einen zuvor dokumentierten Funktionsparameter an einer anderen Stelle in einer Python-Dokumentzeichenfolge referenzieren. Betrachten Sie das folge...