为什么Python没有多行注释?

好的，我知道三引号字符串可以作为多行注释。例如,

"""Hello, I am a 
   multiline comment"""

and

'''Hello, I am a 
   multiline comment'''

但从技术上讲，这些是字符串，对吧?

我已经在谷歌上搜索并阅读了Python风格指南，但我无法找到一个技术上的答案，为什么没有正式实现多行/* */类型的注释。我对使用三引号没有问题，但我有点好奇是什么导致了这个设计决定。

当前回答

三引号文本不应被视为多行注释;按照惯例，它们是文档字符串。它们应该描述你的代码做了什么以及如何使用它，而不是像注释掉代码块这样的事情。

根据Guido的说法，Python中的多行注释只是连续的单行注释(搜索“块注释”)。

为了注释代码块，我有时会使用以下模式:

if False:
    # A bunch of code

其他回答

三引号文本不应被视为多行注释;按照惯例，它们是文档字符串。它们应该描述你的代码做了什么以及如何使用它，而不是像注释掉代码块这样的事情。

根据Guido的说法，Python中的多行注释只是连续的单行注释(搜索“块注释”)。

为了注释代码块，我有时会使用以下模式:

if False:
    # A bunch of code

我记得读过一个家伙，他会把他的多行注释放入一个三引号变量中:

x = '''
This is my
super-long mega-comment.
Wow there are a lot of lines
going on here!
'''

这确实会占用一些内存，但它为您提供了多行注释功能，而且大多数编辑器都会为您突出显示语法:)

通过简单地包装代码，注释代码也很容易

x = '''

and

'''

这只是猜测。但

因为它们是字符串，所以它们有一些语义值(编译器不会删除它们)，因此将它们用作文档字符串是有意义的。它们实际上成为AST的一部分，因此提取文档变得更加容易。

来自The Zen of Python:

应该有一种——最好只有一种——明显的方法来做到这一点。

# This
# is
# a 
# multi-line
# comment

在编辑器中使用注释块或搜索和替换(s/^/#/g)来实现这一点。

推荐文章