21

Pythonコードのドキュメントをクリーンアップしようとしていますが、見栄えが良いのでsphinx-docを使用することにしました。次のようなタグを使用して他のクラスやメソッドを参照する方法が気に入っています。

:class:`mymodule.MyClass` About my class.
:meth:`mymodule.MyClass.myfunction` And my cool function

関数内のパラメーター名を文書化する方法を理解しようとしているので、次のような関数がある場合は次のようになります。

def do_this(parameter1, parameter2):
   """
   I can describe do_this.

   :something?:`parameter1` And then describe the parameter.

   """

これのベストプラクティスは何ですか？

アップデート：

正しい構文は次のとおりです。

def do_this(parameter1, parameter2):
   """
   I can describe do_this.

   :something parameter1: And then describe the variable
   """
4

2 に答える 2

11

通常、「関数変数」はパラメータと呼ばれます;）。

ここに文書化されています：http ：//www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#signatures

そして答えは:param ________

免責事項の編集：私はスフィンクスを使用したことも聞いたこともありません...この投稿は主に「検索する単語」です。お役に立てば幸いです。

于 2012-03-02T14:02:51.163 に答える
6

オプションを統合するためにこの回答を追加します。

pydocは基本的なもので、特別なフォーマットはありません

epydocは「@paramvar：」の形式を使用します

Doxygenはより広い範囲の言語を対象としています

Sphinxはフォーマット'：param type var：'を使用します。その他の例も参照してください。これは、Python3.5のドキュメントを作成するために使用されました。

于 2015-09-21T16:37:29.897 に答える