如何定义自己的 Python 函数？

函数是计算机科学中非常重要的概念。Python 作为一种高级编程语言，提供了许多内置函数和数据类型，同时也支持开发者自己定义函数。定义自己的 Python 函数可以极大地提高代码的复用性和可读性，可实现从简单到复杂的各种逻辑操作。

定义一个 Python 函数的语法如下：

def function_name(parameters):
    """函数的文档字符串"""
    # 函数体
    return [expression]

其中：

- function_name：为自定义函数的名称，有命名规则和限制。Python 函数名称可以以字母或下划线开头，后面可以跟着数字、字母和下划线的组合。

- parameters：表示传递给函数的参数，可以有零个或多个，多个参数使用逗号隔开。

- 函数体：函数体内部的逻辑操作，可以使用 Python 语言提供的各种语句和变量等。

- return 表达式：函数可以有返回值，使用 return 语句指定返回的值，它会立即终止函数的执行并返回值。如果函数没有返回值，可以省略 return 语句。

例如，下面是一个简单的 Python 函数 f1，不带参数和返回值：

def f1():
    print("Hello, Python!")

在 Python 命令行中调用该函数：

>>> f1()
Hello, Python!

下面是一个更复杂的 Python 函数 f2，带有一个参数和返回值：

def f2(a):
    if a > 0:
        return "a 是正数"
    elif a < 0:
        return "a 是负数"
    else:
        return "a 是零"

在 Python 命令行中调用该函数：

>>> f2(3)
'a 是正数'
>>> f2(-3)
'a 是负数'
>>> f2(0)
'a 是零'

Python 函数的文档字符串

函数开发的重要一步是编写文档字符串。文档字符串是位于函数体顶部的一个字符串，用于描述函数的作用、参数、返回值等信息，以便其他人能够很容易地了解函数的功能和用法。

文档字符串使用三个连续的双引号包围，如下所示：

def function_name(parameters):
    """
    这里是文档字符串。

    函数的作用说明。
    参数说明：
      - parameter_name: 参数说明
    返回值说明：
      返回值类型说明

    代码实现部分说明
    """
    # 函数代码实现部分
    return [expression]

文档字符串应该包含以下元素：

- 描述函数的作用；

- 描述函数参数的名称、类型和说明；

- 描述函数返回值类型和说明；

- 描述函数中使用到的较为复杂的算法或者代码实现，方便团队协作或者日后维护。

例如，下面是一个简单的 Python 函数 f3，带有文档字符串：

def f3(x):
    """
    计算 x 的平方。

    参数：
    - x: 输入的数值。

    返回值：
    - x 的平方。

    此函数使用乘法运算实现。当 x 为非数字类型时，将抛出 TypeError 异常。

    用法示例：
    >>> f3(2)
    4
    >>> f3(-2)
    4
    """
    return x * x

当函数名带有下划线时，会被视为“私有函数”，建议将其文档字符串写得更加详细，方便团队协作或者后期维护。

总结

Python 函数是一个非常重要的概念。定义自己的 Python 函数可以提高代码的可重用性和可读性，降低代码出错的风险。

在编写 Python 函数时，需要注意以下几点：

- Python 函数的语法和命名规则；

- 文档字符串的写法和语法；

- 编写规范、易于理解且易于维护的代码。

通过不断练习和实践，就可以掌握 Python 函数的使用技巧，并且在实际开发中应用自如。