問題タブ [docstring]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
2 に答える
1859 参照

python - Python docstring解析(および一般的にPythonでの言語の解析)

Pythonで記述されたRESTAPIの有用なドキュメントを生成したいと思います。

私はそれがこのようなものであるべきだと想像します:

私の構文は明らかに次のとおりです。

この形式を解析して、(たとえば)Python dictを取得したいと思います。できれば、正規表現を使用しないでください。

そのような構文のパーサーはすでに利用可能ですか?
そうでない場合、PythonでDSLを定義および解析する最も簡単な方法は何ですか?

私はreStructuredTextや私が説明したものとは異なるフォーマットを使用したくないことに注意してください。

0 投票する
1 に答える
941 参照

python - 特別なメソッドにdocstringを配置しますか?

__init__クラスdocstringに入れる情報と、メソッドdocstringに入れる情報を決定しようとしています。これまで、クラスの概要とその操作方法をクラスdocstringに入れてきましたが、初期化に直接関連するもの(引数の詳細など)は__init__docstringに入れました。

今日、これが正しい方法かどうか疑問に思い始めたので、いくつかの組み込みモジュールを調べましたが、この__init__メソッドにdocstringが含まれることはほとんどありません。PEP8によると、「非公開メソッドにはDocstringは必要ありません」が、 公開されていません__init__か?

__getitem__同じように、、、、__getattr__などの他の特別なメソッドについては、__new__docstringを使用する必要がありますか?それとも、それらがクラスdocstringに与える影響について言及する必要がありますか?

0 投票する
2 に答える
1347 参照

python - PythonでTestCaseクラスのdocstringを変更するには?

Python 2.5 (実際には Jython) では、UnitTest TestCase クラスの場合、SetUpClass メソッド__init__がなく、実際には受け入れられません (自己への参照はありません)。TestCase 内で docstring を変更しようとすると:

私は得ています:

オブジェクトにインスタンス化してdocstringを変更しようとしました(self.__doc__書き込み可能)。

更新:しかし、サブクラスでの追加のコーディング (つまり、サブクラスの docstring を設定するためのスーパークラス関数の継承) は避けたいと思います。次に例を示します。

ファイル DynamicTestCase.py には以下が含まれます。

ファイル MyTestCase.py には以下が含まれます。

それでも、単体テストの実行結果は次のとおりです。

MyTestCase Docstring = MyTestCaseを期待したとき

0 投票する
1 に答える
4339 参照

python - Python の help() のように Eclipse+PyDev に関数ドキュメントを表示させる方法はありますか?

関数全体ではなくポップアップに Python のヘルプ出力を表示するように Eclipse に強制したいと思います。

コード アシスト ポップアップに "関数の説明" のみを含め、"return 1" を含めないようにしたいと考えています。

0 投票する
4 に答える
30664 参照

python - help() の出力を印刷するオプションはありますか?

help('myfun') の出力を印刷するオプションはありますか。私が見ている動作は、出力が std.out に出力され、スクリプトがユーザー入力を待機することです (つまり、「q」と入力して続行します)。

docstring だけをダンプするように設定する必要があります。

あるいは、docstring と "def f(args):" 行をダンプするだけでも問題ありません。

「python ヘルプ機能」で検索するとコミカルです。:) たぶん、それをすべて説明している素敵なpydocページがどこかにありませんか?

0 投票する
2 に答える
2566 参照

python - python docstringsが機能していませんか?

私は得る

Windows 7 64 ビット、Python 2.6

0 投票する
2 に答える
1572 参照

python - Python: __doc__ doc ストリングが none として表示される

Python を使用して比較的単純なスクリプトをコーディングし、すべてのメソッドのドキュメント文字列を次のように記述しました。

ただし、インタープリターを介してドキュメント文字列を印刷しようとすると、ドキュメント文字列は「なし」として出力されます

ただし、help(weather) はすべてのドキュメント文字列とその他の情報を表示します。それで、私はここで何か間違ったことをしていますか?もしそうなら、ドキュメント文字列にアクセスする正しい方法は何ですか?

ありがとうございました。

0 投票する
1 に答える
156 参照

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

オンライン ヘルプは、このマクロについては有益ではありません。おそらく、Stackoverflow の方がうまくいくのではないでしょうか?

違いが生じる場合に備えて、emacs トランク (24.0.50.1) を使用しています。

ありがとう!

0 投票する
1 に答える
1349 参照

python - epydocはいくつかのクラス関数を非表示にしますか?

私のクラスには、クラスの他のメソッドでのみ使用されることを意図したメソッドがいくつかあります。名前の前に「_」を付けました。これらの関数をepydocから非表示にできますか?それは良い考えですか?

'_'または二重アンダースコアを使用する必要がありますか?正直なところ、いくつかの場所でそれらについて読んだ後、私は違いを理解しませんでした。この命名規則は、モジュール/クラス(インスタンス)関数でのみ使用する必要がありますか?または変数も?