Python中的文档字符串作用

文档字符串是使用一对三个单引号 ‘’’ 或者一对三个双引号 “”"来包围且没有赋值给变量的一段文字说明（如果是单行且本身不含引号，也可以是单引号和双引号）， 它在代码执行时会被忽略，但会被解释器识别并放入所在类、函数或模块的 doc 属性中。

文档字符串在编译模式优化的部分选项情况下，Python会去除，具体可参考《第6章 Python中的动态可执行方法 第6.1节 Python代码编译》，大部分情况下会被Python使用，并在 打印“实例.doc”是打印相关内容。

文档字符串通常用于如下几个方面：

1、模块开头，作为整个模块的文档说明；

2、函数/方法的def语句定义后到函数体之间，用于函数/方法说明；

3、类定义的class语句后到类体之间，用于类说明。

Python推荐的文档字符串格式为：

文档字符串是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开始是详细的描述。文档字符串两个三引号的缩进必须与代码的缩进策略一样。

关于文档字符串的内容请参考：

《第8.19节 使用__doc__访问Python文档字符串（DocStrings ）》

老猿Python，跟老猿学Python!

博客地址：https://blog.csdn.net/LaoYuanPython

欢迎大家点赞、评论和加关注！