0

私は、エンドユーザーが読むことができるはずの Python のメソッドのドキュメントを書いています。Epydocフィールドタグを使用して、与えられた要件に基づいて引数を文書化し、メソッドの説明とメソッドの使用例の間にパラメーターの説明を入れようとしています。

"""
A description of what this utility does.


@param utilityArguments: Description of arguments
@type utilityArguments: String


A list of examples:

example1

example2

example3

"""

残念ながら、type タグから例を除外する方法を見つけることに成功していません。パラメータを引数の最後に移動しないようにしています。ドキュメントのタグを終了し、それに続くテキストを除外する方法はありますか?

4

1 に答える 1