Pydevに関数ドキュメントを表示します

StackOverflow https://stackoverflow.com/questions/4451645

質問

私はPydevを稼働させて走りましたが、ほとんどすべてがうまく機能しています。しかし、私はdocstringsにいくつかの問題を抱えています。

たとえば、次のような関数があるとしましょう。

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

その文字列も適切にフォーマットするためにReprをオーバーライドしたと仮定します。

私がこれをEclipseでホバリングすると、意図したとおりに完全なドキュメントが表示されます。ただし、完全な実装もDoctStingの下に表示されます。

する方法はありますか それだけ ドキュストリングを表示しますか？

役に立ちましたか？

解決

現在は見えません。この問題のためにグーグルでグーグルでグーグルし、一番の結果が私にこれを指摘しました Pydev-Users Post:

2010年5月3日午前5時45分に、Janosch Petersは次のように書いています。

やあ、

関数またはクラスの上にホバリングすると、ドキュストリングだけでなく、関数/クラスの定義全体を示すツールチップが表示されます（予想どおり）。

これは予想される動作ですか？ドックストリングの内容のみが表示されれば、それはもっと便利だと思います。

現在予想されています。 docstringのみをオプションにするだけの機能リクエストを入力してください。

乾杯、

ファビオ

Pydev Bug/Feature Trackerを見回して、この特定の問題が入力されていないことがわかりませんでした。 Pydev Feature Request Trackerに入力し、そこでヘルプを得ることができるかどうかを確認することをお勧めします。

他のヒント

機能リクエストを提出しました Pydevバグトラッカー, 、ID 863で。

Pycharmでは、メソッド名にホバリングすると、実装の詳細なしに、すべてのメソッドのドキュメントのみを示すポップアップが表示されます。そして、タグは好きです @param xx:, @rtype, などは正しく解析され、ポップアップの読み取り可能な形式で表示され、Spinx/epytext/Google/Plainのようなさまざまなスタイルを設定で微調整して、すべての形式を認識できるようにします。

Pydevで同じことを提案したいのですが、タグが解析され、実装の詳細がなく、Javadocのように使用できるドキュストリングを表示するポップアップ <code>some code</code> HTMLのようにレンダリングするには、より良いものです。

これも必要な場合は、このチケットまでの投票を検討してください。 （そして多分ここでも投票してください）

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top