1

だから私はそのようなことをすることを決意しています：

私は欲しい

.. automodule:: main
   :members:

しかし、

This is my caption
------------------

.. autodata:: CAPTION

   About my caption

したがって、各関数、メソッド、およびクラスについて何かを記述する必要がありますが、同時に、コードで作成したすべての新しい関数が、ドキュメントを編集せずにドキュメントに表示される必要があります。することは可能ですか？

4

2 に答える 2

2

ドキュメントから：

undoc-members フラグ オプションを指定しない限り、docstring のないメンバーは除外されます。

.. automodule:: noodle
   :members:
   :undoc-members:

また、「プライベート」メンバー (つまり、_private または __private のような名前のメンバー) は、private-members フラグ オプションが指定された場合に含まれ、Python の「特別な」メンバー (つまり、__special__ のような名前のメンバー) は、特別なフラグ オプションが指定された場合に含まれます。 -members フラグ オプションが指定されています。

.. autoclass:: my.Class
   :members:
   :private-members:
   :special-members:

そして最後に！明示的に文書化された呼び出し可能オブジェクト (関数、メソッド、クラス) の署名を、イントロスペクションから取得した署名をオーバーライドする通常の構文でオーバーライドすることができます。

.. autoclass:: Noodle(type)

   .. automethod:: eat(persona)

回答の冒頭に投稿したリンクには、さらに多くの役立つ情報があります。コードを文書化するためのより高度な方法については、こちらをご覧ください。

于 2014-05-05T06:18:01.283 に答える