好的,我知道三引号字符串可以作为多行注释。例如,
"""Hello, I am a
multiline comment"""
and
'''Hello, I am a
multiline comment'''
但从技术上讲,这些是字符串,对吧?
我已经在谷歌上搜索并阅读了Python风格指南,但我无法找到一个技术上的答案,为什么没有正式实现多行/* */类型的注释。我对使用三引号没有问题,但我有点好奇是什么导致了这个设计决定。
好的,我知道三引号字符串可以作为多行注释。例如,
"""Hello, I am a
multiline comment"""
and
'''Hello, I am a
multiline comment'''
但从技术上讲,这些是字符串,对吧?
我已经在谷歌上搜索并阅读了Python风格指南,但我无法找到一个技术上的答案,为什么没有正式实现多行/* */类型的注释。我对使用三引号没有问题,但我有点好奇是什么导致了这个设计决定。
当前回答
多行注释很容易被破坏。如果你有以下一个简单的计算器程序?
operation = ''
print("Pick an operation: +-*/")
# Get user input here
试着用多行注释注释它:
/*
operation = ''
print("Pick an operation: +-*/")
# Get user input here
*/
哎呀,你的字符串包含结束注释分隔符。
其他回答
因为#惯例是一种常见的惯例,用多行注释确实没有什么是用#符号注释做不到的。这是一个历史的偶然,就像/*…*/返回PL/I的注释,
此外,多行注释是一个婊子。很抱歉,但是不管使用哪种语言,我只将它们用于调试目的。假设你有这样的代码:
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'
}
多行注释将被塞到下一个字符串中,使 “物种”的关键。最好只使用#注释。
这只是猜测。但
因为它们是字符串,所以它们有一些语义值(编译器不会删除它们),因此将它们用作文档字符串是有意义的。它们实际上成为AST的一部分,因此提取文档变得更加容易。
我通过为我的文本编辑器(TextPad)下载一个宏来解决这个问题,它可以让我突出显示行,然后在每行的第一行插入#。类似的宏删除了#。有些人可能会问为什么多行是必要的,但当您为了调试目的而试图“关闭”一段代码时,它就会派上用场。