epydoc中函数变量的文档

Question

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

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

这在EpyDoc网站上指定：

  

也可以使用评论文档字符串记录变量。如果变量赋值紧跟一个注释，其注释行以特殊标记＆＃39;＃：＆＃39;开头，或者通过这样的注释在同一行上跟随，那么它将被视为该变量的文档字符串：

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

Answer 1

你不能，你也不能。 Epydoc和类似工具用于创建API文档，即使用您的函数（类，...）的人员的文档。对于使用函数，函数本地的名称无关紧要，因为它们不是公共接口的一部分。接口只是参数和返回值。实际的实现是一个黑盒子，只要该函数执行其文档所承诺的内容，它就应该是可交换的。