为什么Python没有多行注释?

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

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

and

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

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

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

当前回答

假设他们只是被认为是不必要的。由于键入#注释非常简单，多行注释可以由许多单行注释组成。

另一方面，对于HTML来说，更需要多行程序。继续输入<!——像这样的评论——>。

其他回答

多行注释很容易被破坏。如果你有以下一个简单的计算器程序?

operation = ''
print("Pick an operation:  +-*/")
# Get user input here

试着用多行注释注释它:

/*
operation = ''
print("Pick an operation:  +-*/")
# Get user input here
*/

哎呀，你的字符串包含结束注释分隔符。

此外，多行注释是一个婊子。很抱歉，但是不管使用哪种语言，我只将它们用于调试目的。假设你有这样的代码:

void someFunction()
{
    Something
    /*Some comments*/
    Something else
}

然后，您发现代码中有一些东西无法用调试器修复，因此您开始手动调试，使用这些多行注释注释越来越小的代码块。这将给出函数:

void someFunction()
{ /*
    Something
   /* Comments */
   Something more*/
}

这真让人恼火。

对于任何在Python中寻找多行注释的人来说，使用三引号格式可能会产生一些有问题的后果，我刚刚经历了艰难的过程。考虑一下:

this_dict = {
    'name': 'Bob',

"""
This is a multiline comment in the middle of a dictionary
"""

    'species': 'Cat'
}

多行注释将被塞到下一个字符串中，使 “物种”的关键。最好只使用#注释。

来自The Zen of Python:

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

就我个人而言，我的评论风格在说Java是像

/*
 * My multi-line comment in Java
 */

因此，如果您的风格与前面的示例相同，那么只有单行注释并不是一件坏事，因为相比之下，您将拥有

#
# My multi-line comment in Python
#

VB。NET也是一种只有单行注释的语言，我个人觉得它很讨厌，因为注释最终看起来不像点赞的评论，而更像某种引用

'
' This is a VB.NET example
'

单行注释最终比多行注释使用更少的字符，并且不太可能被正则表达式语句中的一些狡猾的字符转义?不过我倾向于同意内德的观点。

推荐文章