python 函数注释

Python函数注释是指在函数定义时，使用特定的注释格式来描述函数的参数、返回值、功能等信息。通常使用三个引号（'''）或双引号（"""）来包裹注释内容，放在函数定义的第一行或第二行。常见的注释格式包括Google风格、Numpy风格和reStructuredText风格等。其中，Google风格的注释格式如下：

def function_name(param1: type, param2: type) -> return_type:
"""
Description of function.

Args:
param1: Description of param1.
param2: Description of param2.

Returns:
Description of return value.
"""
# Function body

其中，param1和param2表示函数的参数，type表示参数的类型；return_type表示函数的返回值类型；Description of function表示函数的功能描述；Description of param1和Description of param2表示参数的描述；Description of return value表示返回值的描述。这样的注释可以提高代码的可读性和可维护性，方便其他开发者理解和使用该函数。