在Python中，为函数添加文档注释通常使用文档字符串（docstring），它是一个位于函数定义下方的多行字符串，用于描述函数的用途、参数、返回值以及其他相关信息。以下是添加文档注释的一些方法和最佳实践：
文档字符串的位置
文档字符串位于函数定义的下一行，用三重引号括起来。
def add（x, y）:"""计算两个数的和。Args:x （int）： 第一个加数y （int）： 第二个加数Returns:int： 两个数的和"""return x + y
文档字符串的格式
描述函数的目的或功能。
列出参数的名称、类型和用途。
说明返回值的类型和含义。
如果可能，描述可能引发的异常。
提供其他相关信息，如用例示例或注意事项。
获取文档注释
可以使用`__doc__`属性获取函数的文档注释。
print（add.__doc__） 输出：计算两个数的和。
注释符号
单行注释使用``符号。
多行注释使用`"""`或`'''`符号。
其他注释实践
在函数、类和模块的顶部添加文档字符串。
保持注释简洁明了。
根据代码结构使用单行或多行注释。
IDE支持
大多数集成开发环境（IDE）支持文档字符串的自动补全和提示功能，例如在PyCharm中可以通过点击函数名旁边的灯泡图标来查看文档字符串。
遵循这些实践可以帮助你编写清晰、有用的文档注释，从而提高代码的可读性和可维护性