是否有一种普遍接受的方式来注释 Python 中的函数？以下是否可以接受？

#########################################################
# Create a new user
#########################################################
def add(self):

最佳答案

正确的做法是提供一个文档字符串。这样，help(add) 也会吐出你的评论。

def add(self):
    """Create a new user.
    Line 2 of comment...
    And so on... 
    """

三个双引号用来打开评论，另外三个双引号用来结束它。您还可以使用任何有效的 Python 字符串。它不需要是多行的，双引号可以用单引号代替。

见:PEP 257

https://stackoverflow.com/questions/2357230/