是否有一种普遍接受的方式来评论 Python 中的函数?以下是否可以接受?
######################################################### # Create a new user ######################################################### def add(self):
正确的方法是提供一个文档字符串。这样,help(add)也会吐出你的评论。
help(add)
def add(self): """Create a new user. Line 2 of comment... And so on... """
这是打开评论的三个双引号和结束评论的另外三个双引号。您还可以使用任何有效的 Python 字符串。它不需要是多行的,双引号可以用单引号代替。
参见:PEP 257