Python中的 Function Definition （函数定义）

在 Python 中，我们可以定义自己的函数来进行特定的任务或操作。函数定义是一种将函数名与一组语句相关联的结构。当函数被调用时，这些语句将被执行。在 Python 中，使用 def 关键字来定义函数。

语法

def function_name(parameters):
    """
    Document string describing the function.
    """
    # function body
    return [expression]

• function_name：函数名，用于标识该函数。函数名遵循相同的标识符规则，如变量名。
• parameters：函数参数，表示调用函数时传递给函数的值。参数可以是可选的，可以是一个或多个。如果有多个参数，则使用逗号分隔它们。
• Document string：可选的文本字符串用于描述函数的目的，也称为 docstring。
• function body：包含函数执行的一组语句。
• return statement：可选的返回语句，表示该函数将返回的值。如果没有 return 语句，则函数将返回 None。

示例

def calculate_sum(a, b):
    """
    Calculates the sum of two numbers.
    """
    return a + b

result = calculate_sum(2, 3)
print(result) # Output: 5

在上面的示例中，我们定义了一个函数 calculate_sum，该函数接受两个参数 a 和 b，计算它们的和，并返回该和。我们使用该函数将数字 2 和 3 加起来，并将结果存储在变量 result 中，然后将其打印到终端。输出为 5。

DocStrings

在函数定义中，文档字符串是一种描述函数的方式，通常用于调用帮助和文档生成。文档字符串是包含在函数定义中的字符串字面值，放在函数定义语句的第一行下方。

def function_name(parameters):
    """
    Document string describing the function.
    """
    # function body
    return [expression]

文档字符串由三个连续的双引号或三个连续的单引号组成。如果函数没有文档字符串，可以使用 help() 函数来获取函数的参数和文档。

>>> help(calculate_sum)
Help on function calculate_sum in module __main__:

calculate_sum(a, b)
    Calculates the sum of two numbers.

函数的字符串描述将以这种方式打印出来。

除了这些，Python 的函数还有其他很多特性和用途。在代码编写过程中，Python 的函数通常为我们提供了极强的灵活性和效率。