零基础python---函数（十）

1.函数文档

使用 help() 函数，我们可以快速查看到一个函数的使用文档。

使用字符串可以创建一个函数文档：（函数文档一定是在函数的最顶部。）

>>> def exchange(dollar, rate=6.32):
        """
        功能：汇率转换，美元 -> 人民币
        参数：
        - dollar 美元数量
        - rate 汇率，默认值 6.32（2022-03-08）
        返回值：
        - 人民币数量
        """
        return dollar * rate
...
>>> exchange(20)
126.4

help(exchange)
Help on function exchange in module __main__:

exchange(dollar, rate=6.32)
    功能：汇率转换，美元转换成人民币
    参数：
    dollar 美元数量
    rate 汇率，默认值6.32
    返回值：
    人民币数量

2.类型注释

>>> def times(s:str, n:int) -> str:
...     return s * n

上面代码表示该函数的作者，希望调用者传入到 s 参数的是字符串类型，传入到 n 参数的是整数类型，最后还告诉我们函数将会返回一个字符串类型的返回值。

3.内省