在Python中注释函数的正确方式是什么？
在Python中注释函数的正确方式是什么？
提问于 2010-03-02 00:21:13
在Python中是否有一种普遍接受的方法来注释函数？以下是可以接受的吗？
#########################################################
# Create a new user
#########################################################
def add(self):回答 5
Stack Overflow用户
回答已采纳
发布于 2010-03-02 00:23:10
正确的方法是提供一个文档字符串。这样，help(add)也会吐出你的评论。
def add(self):
"""Create a new user.
Line 2 of comment...
And so on...
"""这是三个双引号来打开评论，另外三个双引号来结束它。您还可以使用任何有效的Python字符串。它不需要是多行的，双引号可以用单引号代替。
请参阅：PEP 257
Stack Overflow用户
发布于 2019-11-26 17:02:00
使用docstrings。
这是PyCharm中使用文档字符串注释描述函数的内置建议约定：
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
"""
passStack Overflow用户
发布于 2010-03-02 00:27:08
使用文档字符串，就像其他人已经写过的那样。
您甚至可以更进一步，将doctest添加到您的文档字符串中，从而使函数的自动化测试变得轻而易举。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/2357230
复制相关文章
相似问题