5

在查看 edX.org 上的在线CS188.1x课程中使用的一些代码（由讲师编写的代码）时，我注意到重复使用一组双引号（就像可能在 str 周围使用一样）用作注释。

我以前没有见过这个，也没有在PEP8中提到过我能找到的，但它似乎工作正常。任何人都可以启发我吗？

这是一个例子：

class SomeClass():
    """
    Some docstring info, using standard 'triple double quotes'
    """
    def  __init__(self):
        "This is the comment style to which I'm referring."
        some.code = foo      # Here's a normal inline comment

    def bar(self, item):
        "Here is another example of the comment style"
       return wtf
4

2 回答 2

8

文档字符串是作为类、方法、函数或模块中的第一条语句出现的任何字符串文字。从风格上讲，通常和首选使用三引号格式以允许更长、格式更好的文档字符串，并引起对它们的注意以便于参考，但任何字符串都符合条件。

文档字符串与注释不同，因为注释与程序的执行完全无关，而文档字符串在运行时通过访问对象的__doc__变量可用。

于 2012-10-14T18:25:57.923 回答
0

那只是文档字符串。这是一个很好的设计建议。例如，如果你在你的 python shell 中加载那个类，你可以调用 ahelp(bar)并且你会得到"Here is another example of the comment style"

于 2012-10-14T19:10:30.493 回答