面试题：Python函数文档字符串的规范使用

Question

请说明Python函数中文档字符串（docstring）的定义位置及常规格式要求。假设你有一个计算两个数之和的函数，按照规范为该函数添加文档字符串。

Answer 1

1. 定义位置： 在函数体的第一行使用三引号（''' 或 """）定义文档字符串，在函数定义之后立即书写。
2. 常规格式要求：
   • 一般以一个简短的摘要开始，总结函数的功能，通常不超过一行。
   • 接下来可以有一段空行，然后详细描述函数的参数、返回值、可能引发的异常等信息。
3. 示例：

def add_numbers(a, b):
    """计算两个数之和。

    此函数接受两个数值参数，并返回它们的和。

    参数:
    a -- 第一个数值
    b -- 第二个数值

    返回:
    a 和 b 的和
    """
    return a + b