py: __doc__

版权声明：本文为博主原创文章，未经博主允许欢迎转载。 https://blog.csdn.net/paulkg12/article/details/86535792

每个对象都会有一个__doc__属性，用于描述该对象的作用。在一个模块被import时，其文件中的某些特殊的字符串会被python解释器保存在相应对象的__doc__属性中。比如，一个模块有模块的__doc__，一个class或function也有其对应的__doc__属性。在python中，一个模块其实就是一个.py文件。在文件中特殊的地方书写的字符串就是所谓的docstrings，就是将被放到__doc__的内容。这个“特殊的地方”包括：

1. 一个文件任何一条可执行的代码之前 #模块的__doc__

2. 一个类，在类定义语句后，任何可执行代码前#类的__doc__

3. 一个函数，在函数定义语句后，任何可执行代码前#函数的__doc__

eg

#!/usr/bin/env python
# coding:utf-8

class Test(object):
    """
    用于初始化类
    """
    def __init__(self, a, b):
        self.a = a
        self.b = b

    def res(self):
        return (self.a, self.b)

    def __str__(self):
        return '这是一个类'

t = Test(100, 200)
print t.__doc__
print '-----'
print t


tt: 以下 是运行输出
"""
    用于初始化类
    
-----
这是一个类
"""

output 的图像展示：