Anzeigefunktion Dokumentation in PyDev

Question

Ich habe Pydev und läuft, bekommen und fast alles gut funktioniert. Doch einige Probleme Ich habe mit Docstrings.

Lassen Sie uns sagen zum Beispiel habe ich eine Funktion wie die folgenden:

def _get_logging_statement(self):
    """Returns an easy to read string which separates items in the log file cleanly"""
    result = "\n\n#============================================="
    result += "\n#   %-80s#"(self)
    result =+ "\n\n#============================================"
    return result

Angenommen, ich habe überschriebene repr zu Format, dass Zeichenfolge richtig als auch.

Wenn ich schweben über diese in Eclipse es mir die volle docstring zeigt, wie beabsichtigt. Allerdings ist die vollständige Umsetzung auch unter dem doctsting angezeigt.

Gibt es eine Möglichkeit zu nur die docstring angezeigt?

Answer 1

Sieht nicht gerade. Gegoogelt um für dieses Problem und das Top-Ergebnis zeigte mir, dies zu Pydev-Benutzer senden :

Am Montag, 3. Mai 2010, um 05.45 Uhr, Janosch Peters schrieb:

Hallo,

wenn ich schweben über eine Funktion oder Klasse, erhalte ich ein Tooltip die zeigt, ganz Definition der Funktion / Klasse nicht nur das docstring (wie ich erwarten würde).

Ist das erwartete Verhalten? Ich denke, es wäre sinnvoller sein, wenn nur der Inhalt des docstring gezeigt.

Es wird derzeit erwartet. Bitte geben Sie eine Feature-Anfrage zu machen nur die Docstring eine Option darstellt.

Cheers,

Fabio

Sah die Pydev Bug / Feature-Tracker um und hat dieses spezielle Problem nicht eingegeben finden. Vielleicht haben Sie es in der Pydev Feature Request Tracker eingeben möchten und sehen Sie, wenn Sie Hilfe bekommen können gibt.

Answer 2

Ich habe eine Funktion Antrag in dem PyDev Bug-Tracker , mit ID 863.

In PyCharm, wenn ich auf einen Methodennamen schweben, kann ich ein Popup zeigt sehen nur das Docstring jeder Methode, ohne Implementierungsdetails. Und die Tags wie @param xx:, @rtype usw. sind korrekt analysiert und in einem lesbaren Format in dem Popup angezeigt, und anderer Stil wie spinx / epytext / google / plain können so in den Einstellungen optimiert werden, dass es erkennen alle Formate.

würde Ich mag das gleiche in PyDev vorschlagen: ein Pop-up, die zeigt, docstring mit Tags analysiert, ohne Implementierungsdetails, und wenn wie javadoc kann man <code>some code</code> machen es wie in HTML, besser nutzen.

Betrachten wir zu diesem Ticket stimmen, wenn Sie das auch möchten. (Und vielleicht hier stimmen oben, auch)