3

PHP では、PHPdoc 構文に慣れていました。

/** Do something useful
@param first    Primary data
@return int
@throws BadException
*/
function($first){ ...

— ちょっとした便利なリファレンス: 特にサードパーティのライブラリの場合、「あれは何??」を思い出すだけでよい場合に非常に便利です。また、すべての IDE でこれをポップアップ ヒントに表示できます。

Python には規則がないように思われます。プレーン テキストのみです。よく説明されていますが、ダイジェストするには長すぎます。

わかりました、そうしましょう。しかし、私のアプリケーションでは平文の山を使いたくありません。

従うべきよく知られた規則はありますか? クラス属性を文書化する方法は?! PyCharm IDEレシピは特に歓迎します:)

Python3 には、機能注釈用のPEP 3107があります。これは 2.x (具体的には 2.6) では役に立ちません。

また、reStructuredText のPEP 0287もあります。空想ですが、まだ構造化されていません。

4

2 に答える 2

2

私はエピドックを使用しています。reStructured Text のコメントをサポートし、それらのコメントから HTML ドキュメントを生成します (javadoc に似ています)。

于 2010-12-27T03:39:57.653 に答える
1

numpydoc標準は、reStructuredText (Python エコシステム内の標準) に基づいて明確に定義されており、Sphinx と統合されています。numpydoc を消化できる PyCharm 用のプラグインを作成するのは比較的簡単です。

Sphinx には、属性を文書化する方法に関するリファレンスもあります: http://sphinx.pocoo.org/ext/autodoc.html?highlight=autoattribute

于 2010-12-27T05:16:27.827 に答える