函数-4.2函数说明文档

一、是什么

函数说明文档，顾名思义就是一个对函数说明的信息文档

格式如下

def 函数名():
    """
    用3对双引号进行包裹，这里就是函数的说明文档，用来对函数的功能，使用方式等进行说明
    以便开发人员能够快速的了解此函数
    """
    pass

　　

二、做什么

Python内置了很多的函数，但这些函数具体的功能不是我们编写的，我们很难在较短的时间内读懂函数的实现代码

但是只要有了函数说明文档，我们就能快速的知道这个函数的作用，能够大大提高可读性

那怎样用函数的说明文档呢？下图是在Python交互模式中进行的

三、建议

编写的代码不仅仅是自己看，还有可能是同事看、同学看、领导看等

当我们的代码中有函数，虽然函数说明文档可写可不写，但是王老师建议大家写上，这样会更加规范