在Python评论的行开头的冒号

Question

冒号的功能是什么：在回到这里之前？这是Python中的风格吗？

def close(self):
    """ Close this connection.
    :returns: None
    """
    self.conn.close()
    return

Answer 1

因为它在文档字符串中（用三引号括起来），它就像一个注释，除了记录你的代码之外什么都不做。

编写文档字符串有各种约定 - 这是其中之一（Sphinx使用的reST格式）。

冒号通常用于描述函数期望的参数和函数返回的内容，如下所示：

SELECT * 
  FROM Tb1 
       INNER JOIN Tb2 
          ON Tb1.key1=Tb2.key1 
            OR Tb1.key2=Tb2.Key2

在这种情况下，它表示该函数应返回None。

有关各种惯例的详细信息，请参阅this帖子。

Answer 2

在某些IDE（即PyCharm）上，如果键入三重引号，然后在函数签名下面输入，IDE将自动记录参数并以您显示的样式返回函数/方法的值。它们被称为document comments，并允许IDE在其他地方使用时显示有关参数/返回值的悬停信息。

此文档样式对程序行为没有影响。