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獲得"docstring for x" ？

Answer 1

這是Sphinx和Epydoc等文檔實用程序的一個特性，而不是Python的標准功能。 我不相信有任何直接的方法來獲取變量docstrings。

請參見http://epydoc.sourceforge.net/manual-docstring.html#variable-docstrings

Answer 2

根據PEP 257 ，實例變量應該記錄在類的docstring中：

類的docstring應該總結其行為並列出公共方法和實例變量。

只是在初始化實例變量之后編寫docstring就不會給你任何訪問它的方法。