函数的文档说明

目标:

1. 知道什么是函数文档

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

答：注释

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

答：函数的说明文档

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

1. 语法

• 定义函数的说明文档

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

• 查看函数的说明文档

help(函数名)

2. 快速体验

>>> def test(a,b):
...     "用来完成对2个数求和"
...     print("%d"%(a+b))
... 
>>> test(11,22)
33

如果执行，以下代码

>>> help(test)

能够看到test函数的相关说明

Help on function test in module __main__:

test(a, b)
    用来完成对2个数求和
(END)