python - epydoc 中函数中变量的文档

Question

如何使用 epydoc 记录函数中定义的实例变量。我使用了以下内容，但仅在生成的 html 文档的变量部分中__package__ = None显示。

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

这是在 EpyDoc 网站上指定的：

变量也可以使用注释文档字符串记录。如果变量赋值的前面有一个注释，其行以特殊标记“#:”开头，或者在同一行后面跟着这样的注释，那么它被视为该变量的文档字符串：

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

Answer 1

你不能，你也没有。Epydoc 和类似工具用于创建 API 文档，即为使用您的函数（类，...）的人提供的文档。对于使用函数，函数的本地名称代表什么并不重要，因为它们不是公共接口的一部分。接口只是参数和返回值。实际的实现是一个黑匣子，只要函数按照其文档的承诺进行，就应该是可交换的。