Python 注释 : # vs. 字符串

Question

关于在 Python 源代码中添加注释的“标准”方式:

def func():
    "Func doc"
    ... <code>
    'TODO: fix this'
    #badFunc()
    ... <more code>

def func():
    "Func doc"
    ... <code>
    #TODO: fix this
    #badFunc()
    ... <more code>

我更喜欢将一般注释写成字符串，而不是在 # 前面加上前缀。官方 Python 风格指南没有提到使用字符串作为注释(如果我在阅读时没有错过的话)。

我喜欢这种方式主要是因为我认为 # 字符在注释 block 中看起来很难看。据我所知，这些字符串没有任何作用。

这样做有缺点吗？

Answer 1

不要滥用字符串(无操作语句)作为注释。文档字符串，例如模块、类或函数中的第一个字符串是特殊的，绝对值得推荐。

请注意，文档字符串是文档，文档和注释是两个不同的东西!

• 文档对于理解代码的作用很重要。
• 评论解释了代码是如何做到的。

文档由使用您的代码的人阅读，评论由想要理解您的代码的人阅读，例如维护它。

使用字符串进行注释有以下(潜在的)缺点:

• 这会让不知道字符串什么都不做的人感到困惑。
• 注释和字符串文字在代码编辑器中的突出显示方式不同，因此您的风格可能会使您的代码更难阅读。
• 它可能会影响性能和/或内存使用(如果在字节码编译期间未删除字符串，则删除注释是在扫描仪级别完成的，因此绝对便宜)

对 Python 程序员最重要:它不是 Pythonic:

There should be one—and preferably only one—obvious way to do it.

遵守标准，使用评论。