好的,我知道三引号字符串可以作为多行注释。例如,
"""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风格指南,但我无法找到一个技术上的答案,为什么没有正式实现多行/* */类型的注释。我对使用三引号没有问题,但我有点好奇是什么导致了这个设计决定。
当前回答
我记得读过一个家伙,他会把他的多行注释放入一个三引号变量中:
x = '''
This is my
super-long mega-comment.
Wow there are a lot of lines
going on here!
'''
这确实会占用一些内存,但它为您提供了多行注释功能,而且大多数编辑器都会为您突出显示语法:)
通过简单地包装代码,注释代码也很容易
x = '''
and
'''
其他回答
三引号在文档字符串中用作多行注释。# comments被用作内联注释,人们已经习惯了。
大多数脚本语言也没有多行注释。也许这就是原因?
参见PEP 0008,注释部分
看看你的Python编辑器是否为块注释提供了一些快捷键。Emacs支持它,Eclipse也支持,大概大多数像样的ide都支持。
多行注释很容易被破坏。如果你有以下一个简单的计算器程序?
operation = ''
print("Pick an operation: +-*/")
# Get user input here
试着用多行注释注释它:
/*
operation = ''
print("Pick an operation: +-*/")
# Get user input here
*/
哎呀,你的字符串包含结束注释分隔符。
# This
# is
# a
# multi-line
# comment
在编辑器中使用注释块或搜索和替换(s/^/#/g)来实现这一点。
这可能又回到了一个核心概念,即应该有一种明显的方法来完成一项任务。额外的注释样式增加了不必要的复杂性,并可能降低可读性。
来自The Zen of Python:
应该有一种——最好只有一种——明显的方法来做到这一点。