【无为则无心&Python基础】— 39、Python中函数的说明文档

1、函数的说明文档的作用

思考：定义一个函数后，程序员如何书写程序能够快速提示这个函数的作用？

答：注释

思考：如果代码多，我们是不是需要在很多代码中找到这个函数定义的位置才能看到注释？如果想更方便的查看函数的作用怎么办？

答：使用函数的说明文档

函数的说明文档也叫函数的文档说明。

2、语法

定义函数的说明文档

在定义函数时，可以在函数内部编写函数的说明文档。编写函数的说明文档非常简单，其实直接在函数内的第一行注释的字符串就是函数的说明文档。可以用单引号，也可以使用三引号，但是我们说明函数的时候一行会描述不清楚，通常我们会使用三引号来定义函数的说明文档。

def 函数名(参数):
    """ 说明文档的位置 """
    代码
    ...