python - 数据的文档字符串？

Question

有没有办法以类似于文档字符串描述模块或函数的方式来描述模块的数据？

class MyClass(object):
    def my_function():
        """This docstring works!"""
        return True
    my_list = []
    """This docstring does not work!"""

Answer 1

据我所知，无法将文档字符串分配给模块数据成员。

PEP 224建议使用此功能，但 PEP 被拒绝。

我建议您在模块的文档字符串中记录模块的数据成员:

# module.py:
"""About the module.

module.data: contains the word "spam"

"""

data = "spam"