python72-Python的函数入门，为函数提供文档

之前介绍过可以使用Python内置的help()函数查看其他函数的帮助文档,我们也经常通过help()函数查看指定函数的帮助信息，这对于Python开发者来说非常重要。

我们还可以为函数编写说明文档一只要把一段字符串放在函数声明之后、函数体之前，这段字符串将被作为函数的部分，这个文档就是函数的说明文档。

程序既可通过 help()函数查看函数的说明文档，也可通过函数的__doc__ 属性访问函数的说明文档。下面程序示范了为函数编写说明文档。

# !/usr/bin/env python

# -*- coding: utf-8 -*-

# @Time : 2024/01

# @Author : Laopi

# !/usr/bin/env python

# -*- coding: utf-8 -*-

# @Time : 2024/01

# @Author : Laopi

#定义一个函数，声明两个形参

def my_sum(x,y):

'''

定义一个变量z接收x和y的和

z = x+y

返回变量z的值

'''

#定义一个变量z接收x和y的和

z = x+y

#返回变量z的值

return z



help(my_sum)

print(my_sum.__doc__)

上面程序使用多行字符串的语法为my_sum()函数编写了说明文档接下来程序既可通过help()函数查看该函数的说明文档，也可通过 doc 属性访问该函数的说明文档。运行上面代码，可以看到如下运行结果。