文档字符串的应用场景

在编写大型程序的时候，我们常常会定义很多个函数，有时我们自己也会忘记某个函数是什么功能；在编写面向其他用户的程序时，我们需要明确的告诉用户我们定义的函数是什么功能，这个时候我们可以使用文档字符串。

文档字符串的格式

Python中的文档字符串是有其固定的格式的，一般以三个单引号或三个双引号括起来，放在模块、类、函数的开头，格式如下：

这里是文档字符串的内容，说明这个模块、类、函数的作用、注意事项、实现原理等等信息。

其中三个引号之间的内容就是文档字符串的主体内容，可以是任意文本，但是需要符合一定格式要求，建议规范化地编写。

规范的文档字符串编写

编写规范的文档字符串可以让其他程序员更加容易了解代码的作用、使用方法以及其他相关信息，这对于维护程序、提高代码可读性来说都非常重要。下面，我们给出一个函数的规范文档字符串的样例：

def example():
    'wendangzifuchuan'
    pass
文档字符串也可以用" "（双引号）或''' '''（三引号）连接

文档字符串的使用

如果使用过python的help()函数就会发现，python的内置函数都可以通过help()函数获得一些简单的说明。而这些说明就定义在文档字符串内。所以文档字符串定义后就可以通过help()函数获取到。

上面的example函数若使用help函数就会返回如下结果：

>>> help(example)
Help on function example in module __main__:
 
example()
    wendangzifuchuan

本文由mdnice多平台发布