在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 documentation明确禁止此行为：

  

在对象的描述之后，字段必须放在docstring的末尾。字段可以包含在任何顺序中。

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