文档字符串

python支持自动附件在对象上的文档，可以在运行时查看。从语法上来看，就是可以跨行的字符串注释。这种注释可以放在模块开头，函数顶部，以及类顶部。这些字符串被正式的称为“文档字符串”。python会自动装载文档字符串的文本，使其称为相应对象的__doc__属性。

用户自定义文档字符串

用户自定义文档字符串非常简单，直接按照上面所属即可。例如下面的代码，我保存在一个名为doc_str.py的文件中。

#! /usr/bin/env python3
"""
模块文档
"""


def func():
    '''
    函数文档
    '''
    ...


class Cclass:
    '''
    类文档
    '''
    ...

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18

然后，在test.py文件（该文件和doc_str.py位于同一个目录下）中导入该文件，然后就可以使用相应的__doc__属性来获取文档注释。例如：

import doc_str


print(doc_str.__doc__)
print(doc_str.func.__doc__)
print(doc_str.Cclass.__doc__)

• 1
• 2
• 3
• 4
• 5
• 6

这就是test.py文件的内容，执行结果如下：

zy@zy-PC:/media/zy/新加卷1/学习/Python$ python3 test.py 

模块文档


    函数文档


    类文档

zy@zy-PC:/media/zy/新加卷1/学习/Python$ 

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11

应当详细的为python代码编写文档，因为这是写好代码很重要的步骤。