epydoc中变量函数的文档化

Question

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

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

这是在EpyDoc网站上指定的：

还可以使用注释文档字符串记录变量。如果变量赋值立即被注释(其行以特殊标记‘'#:’)开头，或者在同一行上由这样的注释紧跟，那么它将被视为该变量的docstring：

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

Answer 1

Epydoc和类似的工具用于创建API文档，即为使用您的函数(类、…)的人员编写文档。。对于使用函数，函数的本地名称代表什么并不重要，因为它们不是公共接口的一部分。接口只是参数和返回值。实际的实现是一个黑匣子，应该是可交换的，只要函数做了它的文档承诺的事情。