python - Python 注释的一组双引号?

标签 python coding-style comments

在查看在线 CS188.1x 中使用的一些代码时在 edX.org 上的类(class)(由讲师编写的代码)中,我注意到重复使用了一组双引号(就像有人可能在 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

最佳答案

A docstring是在类、方法、函数或模块中作为第一条语句出现的任何字符串文字。在文体上,使用三重引号格式是典型且首选的方式,以允许更长、格式更好的文档字符串,并引起对它们的注意以便于引用,但任何字符串都符合条件。

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

关于python - Python 注释的一组双引号?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/12885168/

相关文章:

string - 如何在 Groovy 中获取带有牛津逗号的单个字符串?

parsing - 为什么解释/脚本语言很少有多行注释?

python - 从字符串中解析日期并使用 Sqlalchemy tosqlite 插入

python - 在python中检测按下了哪些键

java - else 和 else-if 语句是否应该位于不同的行

c++ - 文件模板 C++ Visual Studio 2012

XCode:将一个长注释拆分为固定字符数的多行

javascript - django 无法将 dictdata 传递到 javascript 变量中

python - 对首次 sourceforge 项目贡献者的建议?

android - 如何将主题/样式应用于 Action android