【python coding 6：文档字符串】Python的文档字符串DocStrings

 Python有一个很奇妙的特性，称为 文档字符串 ，它通常被简称为 docstrings 。DocStrings是一个重要的工具，由于它帮助你的程序文档更加简单易懂。

 其作用如同我们写代码时所添加的注释一样，但是不同之处是这个注释，可以使用print方法将其打印出来，具体实例见示例：

 

#!/bin/env python
'''2014-08-09 DJY<span style="font-size:18px;">'</span>''

#在定义的类名方法名的冒号之后，添加’’’XXXXXXXX’’’，作为对此代码块的描述。
#在后面打印的类或者方法的时候，就会输出该段描述。
class TestClass:
        '''This is TestClass' DocStrings'''

def func1():
        '''this is func1's DocStrings'''

def func2():
        '''this is func2'''

print 'func1 output: '+func1.__doc__
print 'func2 output: '+func2.__doc__
print 'TestClass output:'+TestClass.__doc__

 

运行结果：