python - 在 Pythons Epydoc 中的段落之间记录标签

Question

我正在为 python 中的方法编写文档，这些文档应该可供最终用户阅读。我正在使用 Epydoc 字段标签根据给我的要求记录参数，并尝试将参数描述放在方法描述和使用该方法的示例之间：

"""
A description of what this utility does.


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


A list of examples:

example1

example2

example3

"""

不幸的是，我没有成功找到从类型标签中排除示例的方法，它们被添加到其中而不是分开。我试图不将参数移动到参数的末尾，因为我们觉得这看起来更整洁；有什么方法可以终止文档标签并从中排除任何以下文本？

Answer 1

很抱歉成为坏消息的承担者，但Epydoc 文档明确禁止这种行为：

字段必须放在文档字符串的末尾，在对象的描述之后。可以按任何顺序包含字段。

由于字段是全部@param和@return标记，这意味着字段之后的所有内容都将被视为该字段的一部分（除非它是另一个字段）。