python的__doc__

直接问GPT的回答如下，但是提供的例子不够好。

__doc__ 是 Python 中用于保存对象（模块、类、函数等）文档字符串的特殊属性。

文档字符串（docstring）是编写在代码中用于文档自述的字符串。它通常用于提供关于代码目的、用法示例、参数说明等详细信息，以便用户或其他开发者可以理解并正确使用代码。文档字符串是对代码功能和使用的重要说明，也是代码可读性和可维护性的一部分。

Python 为每个对象（模块、类、函数等）都提供了一个 __doc__ 属性，用于存储与该对象相关的文档字符串。

自己写了一个模块，类和模型的示例，更好理解：

"""
define: test.py
"""
class a(object):
    """
    function: 测试文件
    input: None
    output: None
    """
    def main():
        """
        function: main函数
        """
        pass
    
if __name__ == '__main__':
    print(__doc__)				# 对于模块, 直接 print __doc__
    print(a().__doc__)			# 对于实例化的类 classA(), 当作一个属性print classA().__doc__
    print(a().main.__doc__)		# 对于函数 function(), 直接 print function.__doc__

第一个 print 输出

define: test.py

第二个 print 输出

    function: 测试文件
    input: None
    output: None

第二个 print 输出

        function: main函数

要注意到其实连空格都按照格式原封不动打印了。