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 实际类型的文档。

所以问题是：我该如何从 self.x 中获取 "x的文档字符串" 呢？

Answer 1

根据 PEP 257 的规定，类的实例变量应该在类的文档字符串中进行说明：

类的文档字符串应该总结它的行为，并列出公共方法和实例变量。

仅仅在实例变量初始化后写文档字符串，并不能让你访问这个变量。

Answer 2

这是一些文档工具的功能，比如 Sphinx 和 Epydoc，而不是 Python 的标准功能。我认为没有直接的方法可以获取变量的文档字符串。

可以查看这个链接了解更多信息：http://epydoc.sourceforge.net/manual-docstring.html#variable-docstrings