Python编写函数注意事项总结

函数的命名

• 函数名应该有意义，清晰易懂
• 应该符合PEP 8规范，即使用小写字母和下划线拼接，且具备描述性

例如：

# bad
def func(a, b):
    pass

# good
def calculate_sum(a, b):
    pass

函数的文档注释

• 应该使用文档注释对函数进行描述，使得用户可以快速理解函数的作用和使用方法
• 应该符合PEP 257规范

示例：

def calculate_sum(a, b):
    """
    返回a和b的和。

    :param a: 加数1
    :type a: int
    :param b: 加数2
    :type b: int
    :return: a和b的和
    :rtype: int
    """
    return a + b

参数的默认值

• 可以为函数参数赋默认值，从而使得部分参数在不传递值的情况下使用默认值
• 默认值应该视情况而定，应该具备实际意义

示例：

def calculate_sum(a, b=0):
    """
    返回a和b的和。

    :param a: 加数1
    :type a: int
    :param b: 加数2，默认为0
    :type b: int
    :return: a和b的和
    :rtype: int
    """
    return a + b

参数的类型注解

• 可以使用类型注解来指定函数参数和返回值的类型

示例：

def calculate_sum(a: int, b: int) -> int:
    """
    返回a和b的和。

    :param a: 加数1
    :param b: 加数2
    :return: a和b的和
    """
    return a + b

处理异常

• 在函数中处理可能出现的异常，以避免程序崩溃或出现不可预料的结果

示例：

def divide(a: float, b: float) -> float:
    """
    返回a除以b的商。

    :param a: 被除数
    :param b: 除数
    :return: a除以b的商
    :raises ZeroDivisionError: 当b为0时抛出异常
    """
    if b == 0:
        raise ZeroDivisionError("除数不能为0")
    return a / b