Python - 注释


Python 注释

计算机程序中的注释是一段文本,旨在作为源代码中的解释性或描述性注释,并且在生成机器语言代码时不被编译器/解释器考虑。源程序中充分使用注释可以让大家更容易理解算法的语法、用法和逻辑等,只要注释得很好。

Python 注释使代码更容易理解,并且解释器完全忽略它们,这意味着您可以在程序中提供任意多的注释,以使其更具可读性和解释性。

Python 支持两种类型的注释:

  • 单行注释
  • 多行注释

Python 中的单行注释

在 Python 脚本中,符号 # 标记注释行的开始。它在编辑器中一直有效到行尾。如果 # 是该行的第一个字符,则整行将被假定为注释,解释器将忽略它。

# This is a comment
print ("Hello World")

如果在行中间使用 #,则其前面的文本是有效的 Python 表达式,而其后面的文本将被视为注释。

print ("How are you?") # This is also a comment but after a statement.

有时,你不想执行某行Python代码,那么你可以简单地注释掉它,如下所示:

# This is a comment
# print ("How are you?")
print ("Hello World")

Python 中的多行注释

在Python中,没有提供编写多行注释或块注释的规定。(就像在 C/C++ 中一样,/* .. */ 内的多行被视为多行注释)。

每行开头都应有“#”符号,以便在 Python 中标记为注释,这就是在 Python 中创建多行注释的方法。许多 Python IDE 都有将语句块标记为注释的快捷方式。

#
# This is a multi-line comment
#  which can span through multi-line.
#
print ("Hello World")

如果三引号多行字符串不是函数或类的文档字符串,则它也被视为注释。

'''
First line in the comment
Second line in the comment
Third line in the comment
'''
print ("Hello World")