python - 文档字符串用于数据？

有没有一种方法可以以类似于文档字符串描述模块或功能的方式描述模块的数据？

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

最佳答案

据我所知，不可能为模块数据成员分配文档字符串。

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

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

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

module.data: contains the word "spam"

"""

data = "spam"

关于python - 文档字符串用于数据？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/197387/