0

epydoc を使用して関数で定義されたインスタンス変数を文書化する方法。以下を使用しましたが、生成されたhtmlドキュメントの変数セクションにのみ__package__ = None表示されます。

def fun()
     x = 22    #: Document defining the purpose of x

これは EpyDoc Web サイトで指定されています。

変数は、コメント docstring を使用して文書化することもできます。変数の代入の直前に特別なマーカー '#:' で始まる行を持つコメントがある場合、または同じ行でそのようなコメントが続く場合、それはその変数の docstring として扱われます。

#: docstring for x
x = 22
x = 22 #: docstring for x
4

1 に答える 1

0

あなたはできませんし、しません。Epydoc および同様のツールは、API ドキュメント、つまり関数 (クラスなど) を使用する人々のためのドキュメントを作成するためのものです。関数を使用する場合、関数のローカルな名前はパブリック インターフェイスの一部ではないため、その名前が何を表しているかは問題ではありません。インターフェイスは、引数と戻り値だけです。実際の実装はブラック ボックスであり、関数がそのドキュメントで約束されていることを実行する限り、交換可能である必要があります。

于 2014-07-13T14:18:01.113 に答える