pycharm“”：在Python文档字符串中返回：“”

Question

当您使用Pycharm编辑py文件时，它会插入这样一个模板。在

def check_caller_log():
    """
    xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    :return: 
    """

这里:return:的目的是什么？在

Answer 1

作为斯特凡.stt的答案是，:return:字段允许您提供函数返回值的描述。然而，斯特凡.stt的示例显示了:return:用于记录返回值类型，而不是用来描述值。为了记录类型，通常使用:rtype:字段，因此：

def user_name():
    """
    Description of the function goes here.

    :return: the name of the currently active user
    :rtype: str
    """

字段名没有完全标准化，并且:returns:也被广泛用于记录返回值；我的印象是{}是这两个同义词中更常用的，但是PyCharm的“Python集成工具”已经对:result:进行了标准化。广泛使用的Python文档生成器Sphinxsupports both variants，但其他文档工具可能没有。在

还值得注意的是，在Python docstring中，有几种不同的语法用于记录参数、返回值等。最常见的记录在this answer中。在

Answer 2

它描述函数返回的类型（例如，如果它返回一个字符串，则写return: str）。你也可以加上它的目的是什么或者它的值是什么。在

def my_function():
    """
    Some good explanation of what this function does

    :return: str
    """

注意：如果您的函数没有返回任何值，那么它实际上不返回任何值，您可以将它写下来：return: None

^{pr2}$