docstring

3熱

2答えて

構造化Pythonのdocstringを、IDEに優しい私はPHPDOC構文に使用されたPHPで

： /** Do something useful @param first Primary data @return int @throws BadException */ function($first){ ... - ちょっと短い便利参照：あなたが必要とするすべてがちょうど「は何??」リコールするときに非常に便利な、特にサードパーティのライブラリ用。また、すべてのIDEがポップ

4熱

3答えて

pythonファイルのドキュメント文字列を取得する

ファイル名のみを持つ場合、pythonファイルのドキュメント文字列を取得する方法はありますか？例えば、私はa.pyという名前のpythonファイルを持っています。私はそれがドキュメント文字列（前に義務付けられている）を持っていることを知っていますが、クラスやメインなどの内部構造を知らないのですか？ filename.__doc__ #it does not work

8熱

1答えて

VIMを使用してPythonで関数のドキュメント文字列を表示できますか？

PythonをVIMに書き込むときに、関数のドキュメント文字列を表示する方法はありますか？例えば： def MyFunction(spam): """A function that foobars the spam returns eggs""" return foobar(spam).eggs() 私がツールチップとして、あるいはステータスバーまたはVIMが

1熱

1答えて

GNU emacs lisp：with-wrapper-hookマクロは何をしますか？説明と例を教えてください。

このマクロについては、オンラインヘルプが参考になりません。おそらくStackoverflowはうまくいくでしょうか？違いがある場合は、emacs trunk（24.0.50.1）を使用しています。ありがとうございます！

3熱

1答えて

ドキュメントストリングをドキュメント化した関数とは別に保つ方法はありますか？

私は多くの小さな機能を持つモジュールで作業していますが、ドキュメントストリングはかなり長い傾向にあります。ドキュメントストリングは、実際のコードのほんの少しを見つけるために、長いドキュメントストリングを常にスクロールしなければならないので、モジュールの作業を苛立たせます。ドキュメントストリングをドキュメント化した関数とは別に保つ方法はありますか？コードから離れたファイルの終わりにdocstrin

5熱

1答えて

ネストされたのdocstring doctestの

は、私は次のコードがあるとします。 def foo(s): """A dummy function foo. For example: >>> a = '''This is a test string line 1 This is a test string line 2 This is a test string line 3''' >>> foo(a) This is a

1熱

3答えて

docstringsにhtmlテンプレートを格納していますか？

Flaskを使用して、私の仕事で内部アプリケーションのWebサービスを記述しています。多くのWebサービスURIがHTML部分を返します.HTMLテンプレート文字列を格納するためのきれいな方法を見つけようとしています。私はテンプレートの文字列を別々のファイルに入れたくないのです。なぜなら、通常は数行しかないので、それぞれに3行のテンプレートファイルが20個ありたくないからです。私は、関数のdocs

10熱

1答えて

'yield'キーワードのDocstringタグ

や @returnのような、pythonでdocstringのタグがいくつかあります。例えば： def my_method(a_param): ''' @param a_param: Description of this param @return: The return value of the method ''' return int(a_para