在Python中,可以使用docstrings来为函数添加注释。Docstrings是放在函数定义开头的一行或多行字符串,可以用来解释函数的功能和用法。
有两种方式为函数添加注释:
- 单行注释:使用井号(#)在注释行的开头。这种注释只对一行有效,多行注释需要使用三个单引号(‘’')或三个双引号(“”")。
def func(): # 这是一个单行注释 pass
- 多行注释:使用三个单引号(‘’')或三个双引号(“”")将注释内容包裹起来。这种注释可以跨越多行。
def func(): ''' 这是一个多行注释 可以跨越多行 ''' pass
在函数注释中,可以介绍函数的功能、参数、返回值等信息,以便其他开发者阅读和理解代码。例如:
def add(a, b): """ 计算两个数的和 参数: a -- 第一个加数 b -- 第二个加数 返回值: 两个数的和 """ return a + b