【python 关于python的文档字符串(docstring)】的注意点

Python 中的函数只能有一个文档字符串（docstring），它必须是紧跟在函数定义后面的第一段字符串，位于函数体代码之前。如果你在一个函数中写了多段看起来像文档字符串的文本，只有第一段会被当作文档字符串，其他的不会被识别为文档字符串。

下面是一个正确设置文档字符串的例子：

def my_function():
    """
    这是函数的文档字符串。
    它会在函数定义后立即出现。
    """
    # 这里是函数的代码部分
    pass

在这个例子中，my_function.__doc__ 会返回 "这是函数的文档字符串。\n它会在函数定义后立即出现。\n"。

如果你尝试在代码部分之后添加另一段看似文档字符串的文本，它不会被识别为文档字符串：

def my_function():
    """
    这是函数的文档字符串。
    """
    # 这里是函数的代码部分
    pass
    """
    这不是文档字符串。
    它会被视为普通的字符串。
    """

在这个例子中，my_function.__doc__ 仍然只会返回第一段字符串 "这是函数的文档字符串。\n"，而第二段字符串 "这不是文档字符串。它会被视为普通的字符串。" 不会被识别为文档字符串，它只是函数体中的一个普通字符串。

因此，当你打印一个函数的文档字符串时，只有定义在函数开头的那部分字符串会被输出。