【Python】函数「五」——“写给别人看的“——关于函数书写规范

这方面我也是抛砖引玉，具体来说有两个方法供大家参考

Python官方鼓励的类型标注

def add(a: int, b: int) -> int:
    return a + b

可以注意到，我为参数a、b和函数返回值都写明了类型，但仅仅是写明，Python并不会自动帮你检测，不过这种方式简洁明了，也是官方鼓励的。而当参数的类型有多种可能时，可以这样写：

def myprint(msg: list[str] or str="") -> None:
    if isinstance(msg, str):
        print(msg)
    else:
        print(", ".join(msg))

myprint()
myprint("hello world")
myprint(["hello", "world"])

为函数添加注释

不同的注释有不同的风格，我这里展示两种作为参考

第一种

def add(a: int, b: int) -> int:
    """a plus b

    Args:
        a (int): number
        b (int): number

    Returns:
        int: result
    """
    return a + b

第二种

def add(a: int, b: int) -> int:
    """
    a plus b
    :param a: int
    :param b: int
    :return: int
    """
    return a + b