每个pytho文件自动生成头部注释

在Python中，为了提高代码的可读性和一致性，许多开发者习惯在每个Python文件的开头添加一个文档字符串（Docstring），这是一种特殊类型的字符串，用于对代码块进行解释和说明。这种头部注释通常是三引号(```"""``` 或 `'''`)包围的内容，位于函数、类、模块或其他代码块的上方。例如：

# 这是模块my_module.py的文档字符串
"""
这个模块包含了一些计算数学函数的工具。
"""

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

    参数:
        a (int): 第一个数字
        b (int): 第二个数字

    返回值:
        int: 两数之和
    """
    return a + b

当你查看或生成API文档的时候，这些注释会被自动提取出来，如使用`docopt`、`sphinx`等工具，或者直接在IDE（如PyCharm）中按需显示。此外，一些持续集成/持续部署(CI/CD)系统如Read the Docs也支持解析文档字符串以生成在线帮助文档。