python写文档字符串

Python 中的文档字符串（docstring）是描述模块、函数、类等 Python 对象的工具，它通常写在对象的开头位置，使用三个引号（'''）或三个双引号（"""）包括起来。

文档字符串的格式通常如下所示：

def func_name(arg1, arg2):
    """
    函数功能描述

    :param arg1: 参数1的说明
    :type arg1: 参数1的类型
    :param arg2: 参数2的说明
    :type arg2: 参数2的类型
    :return: 返回值的说明
    :rtype: 返回值的类型
    """
    # 函数体代码

其中 `func_name` 是函数名，`arg1` 和 `arg2` 是函数的参数名，`return` 是函数的返回值。

在文档字符串中，可以使用 reStructuredText 或者 Sphinx 等标记语言来格式化文本，详细介绍请参考 Python 官方文档：https://docs.python.org/3/tutorial/controlflow.html#documentation-strings