课程大纲 第 25 课,共 250 课 · 函数
函数

文档字符串与类型提示

两个小改动就能把一个能用的函数变成专业的函数:文档字符串和类型提示。

文档字符串(docstring)是放在函数体第一行的字符串字面量。它说明函数做什么。工具和 help() 会读取它,Python 把它保存在 function.__doc__ 上:

def add(a, b):
    """Return the sum of a and b."""
    return a + b

print(add.__doc__)   # Return the sum of a and b.

三引号让文档字符串可以跨多行,这对较长的说明很方便。

类型提示标注参数和返回值预期是什么类型。每个参数写 name: type,返回值写 -> type:

def add(a: int, b: int) -> int:
    """Return the sum of a and b."""
    return a + b

类型提示在运行时并不强制任何东西。Python 不会阻止你传入一个字符串。它们是编辑器和检查工具用来尽早发现错误的文档,也让你的函数签名一目了然。常见的提示类型有 int、float、str 和 bool。

从现在开始,写函数时两者都要有:清楚的文档字符串和诚实的类型提示。

轮到你了

定义一个函数 multiply,类型提示为 def multiply(a: int, b: int) -> int:,并带一个文档字符串(函数体第一行),内容恰好是 Return the product of a and b.。函数体应该 return a * b。

发现这节课有问题?报告它 · 就这节课提问

这个练习即将开放

完成它前面的那一课,这一课就会解锁。整门课程免费,无需账号,而且你现在就可以阅读这节课。