Python获取实例变量的__doc__文档

Question

在python中，我知道我应该记录这样的实例变量：

self.x = 22
"""docstring for x"""

#: docstring for x
self.x = 22
self.x = 22 #: docstring for x

但我似乎找不到在代码中获取该文档的方法。 MyClass.x.__doc__向我提供了x

中实际类型的文档

所以问题是：我如何从"docstring for x"获得self.x？

Answer 1

这是文档实用程序的一个功能，例如Sphinx和Epydoc，而不是Python的标准功能。我不相信有任何直接的方法来获取变量文档字符串。

请参阅http://epydoc.sourceforge.net/manual-docstring.html#variable-docstrings

Answer 2

根据PEP 257，实例变量应该记录在类的docstring中：

  

类的docstring应该总结其行为并列出公共方法和实例变量。

在初始化实例变量后编写docstring不会给你任何方法来访问它。