:return: 评论里面的关键词

Question

我在函数内写了一条评论，我的 IDE 像这样自动完成了它：

async def some_func():
    """

    :return:
    """

这是什么：return：用于什么，我在哪里可以阅读更多相关信息？

Answer 1

这是 sphinx 文档字符串格式的一部分（还有许多其他格式类型，如 numpy、google 等）。这个link应该有助于详细描述。

这些文档字符串规范有助于自动生成文档，就像您在许多 python 包中看到的那样（例如 link 请参阅“Returns”部分）