2010-12-15 4 views
19

Pydevを起動して実行していて、ほとんどすべてがうまくいきます。しかし、私はdocstringsにいくつか問題があります。PyDevでの関数ドキュメントの表示

のは、私は次のような機能を持っ例えばとしましょう:

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の下にも表示されます。

への道はありますかはdocstringを表示していますか?

+0

注:ドキュメントストリングを実装の下に置くことは望ましくありません。それはPEP標準に反しているようです。 – Scott

+1

ダブルアンダースコアのメソッドは不愉快です(関数の名前が変更され、バグが発生し、セキュリティが向上しません)。 – katrielalex

+0

katrielalexに続いて、* single *アンダースコアで始まることはトラブルを回避し、慣例により「内部」とみなされます。 –

答えて

15

現在のようには見えません。この問題のために周りGoogleで検索してトップの結果は、このPydev-users postに私を指摘:月、2010年5月3日に

を5:45で、ジャノスチピーターズは書きました:

こんにちは、

私は関数やクラスの上にマウスを置くと、関数/クラスの定義全体を示す のツールチップを得ることができます(私は のように)。

これが期待どおりの動作ですか?私はそれがより有用であると思う、 のdocstringの内容が示されれば。

現在のところ、 にdocstringだけを表示する機能要求を入力してください。

乾杯、

ファビオ

はPyDevはバグ/機能トラッカーの周りを見て、この特定の問題が入っ見つけることができませんでした。あなたはPydev機能要求トラッカーにそれを入力して、そこに助けを得ることができるかどうかを知りたいかもしれません。

0

私はメソッド名の上にカーソルを移動するとき、私は実装せずに、すべてのメソッドの のみドキュメンテーション文字列を示すポップアップを見ることができますPyCharmでID 863

と、PyDev bug trackerに機能要求を提出しました詳細。 そして、@param xx:@rtype、などのようなタグは、正しく を解析され、ポップアップで読みやすい形式で示され、そしてそれは 認識できるように spinx/epytext /グーグル/無地などのさまざまなスタイルが設定で微調整することができていますすべてのフォーマット。

私はPyDevはで同じことを提案したい:実装の詳細がなくて、解析されたタグと ドキュメンテーション文字列を示してポップアップを、およびjavadocのような 場合、1はHTML、より良いのように、それをレンダリングするために<code>some code</code>を使用することができます。

これもまた必要な場合は、このチケットまで投票してください。

関連する問題