Python函数文档书写规范有哪些?
时间: 2023-05-23 14:02:42 浏览: 100
Python代码书写规范与基本使⽤.pdf
Python函数文档应该至少包含函数的名称、参数、返回值和功能描述,如下所示:
```
def function_name(param1, param2):
"""
Function description.
:param param1: description of param1
:param param2: description of param2
:return: description of return
"""
# function code
```
其中,函数描述应放在函数的第一行,并以三个引号括起来;参数和返回值应该用冒号隔开,前面加上一个参数名称或“return”。
阅读全文