说明文档
通过注释对函数进行解释说明
在PyCharm编写代码时,可以通过鼠标悬停,查看调用函数的说明文档
def func(x, y):
"""
函数说明
:param x: 参数x的说明
:param y: 参数y的说明
:return: 返回值的说明
"""
函数体
return 返回值
def add(x, y):
"""
add函数可以接收2个参数,实现2数相加的功能
:param x: 形参x表示相加的其中一个数字
:param y: 形参y表示相加的另一个数字
:return: 返回值是2数相加的结果
"""
return x + y
print(add(1, 2))
