Python中注释函数的正确方法是什么？
在Python中是否有一种公认的注释函数的方法？以下情况是否可以接受Python中注释函数的正确方法是什么？,python,Python,在Python中是否有一种公认的注释函数的方法？以下情况是否可以接受 ######################################################### # Create a new user ######################################################### def add(self): 阅读有关在Python代码中使用的内容 根据Python文档字符串约定： 函数或方法的docstring应该总结其行为，并记录
#########################################################
# Create a new user
#########################################################
def add(self):
这里没有黄金法则，而是提供对团队中的其他开发人员（如果您有）或甚至对您自己有意义的注释，当您在六个月后再次使用它时。正确的方法是提供一个文档字符串。这样，
help（add）def add(self):
"""Create a new user.
Line 2 of comment...
And so on...
"""
请参阅：我会选择与文档工具集成的文档实践，如 第一步是使用
docstringdef add(self):
""" Method which adds stuff
"""
\uuuu doc\uuuu\uuu init\uu\uuuuu init\uuuuuuupy\uuuu doc\uuu\uuuu init\uuuu正如其他人已经编写的那样，使用docstring
您甚至可以更进一步，在docstring中添加一个，使功能的自动测试变得简单。好的评论原则是相当主观的，但这里有一些指导原则：
- 函数注释应描述函数的意图，而不是实现
- 概述您的函数对系统状态所做的任何假设。如果它使用任何全局变量（tsk，tsk），请列出这些变量
- 小心过度使用。拥有长长的哈希字符串似乎可以使注释更容易阅读，但当注释发生变化时，处理它们可能会很烦人
- 利用提供“自动文档”的语言特性，即Python中的docstring、Perl中的POD和Java中的Javadoc
def test_function(p1, p2, p3):
"""
test_function does blah blah blah.
:param p1: describe about parameter p1
:param p2: describe about parameter p2
:param p3: describe about parameter p3
:return: describe what it returns
"""
pass
你可以用三个引号来做这件事 您可以使用单引号：
def myfunction(para1,para2):
'''
The stuff inside the function
'''
def myfunction(para1,para2):
"""
The stuff inside the function
"""
def myfunction(para1,para2):
'''
The stuff inside the function
'''
def myfunction(para1,para2):
"""
The stuff inside the function
"""
注意，它不必是三重引用的；任何字符串文字都可以。但你们可以把更多的信息放在一个多行字符串中，尽管按照惯例，它应该是三重引号。我从来没有见过一个不是的文档串，这并不是说我不同意。它们应该是三重引号，但在野外你会看到一些不是。你也可以用三个单引号（而不是三个双引号）来打开和关闭docstring。你不也应该缩进注释吗？这没有什么主观的，Python非常清楚如何使用docstring注释。@fuzzy lollipop，我很感谢你的评论，但你会注意到我的最后一点正好说明了这一点。也许OP的问题只是关于Python注释的机制，但我认为我的答案不值得往下说。如果没有链接页面，这个答案很弱。这不应该缩进（在带有
def