跳至内容

Python注释

在计算机编程中,Python注释是对编写的代码进行解释说明。注释不会被Python解释器执行,他们只是起到提示程序员的作用。

python
# 两名和初始化两个变量
num1 = 6
num2 = 9

# 打印输出结果
print('This is output')
# 两名和初始化两个变量
num1 = 6
num2 = 9

# 打印输出结果
print('This is output')

这里,我们用到了两条注释

  • 两名和初始化两个变量
  • 打印输出结果

注释类型

Python中, 有两种类型的注释:

  • 单行注释
  • 多行注释

单行注释

单行注释在同一行开始和结束。我们使用#符号来编写单行注释。

输入

python
# 创建一个变量
name = 'w3query'

# 打印变量值
print(name)
# 创建一个变量
name = 'w3query'

# 打印变量值
print(name)
运行代码

输出

python
w3query
w3query

这里,创建了两个单行注释

  1. # 创建一个变量
  2. # 打印变量值

我们也可以在单行代码的后面使用注释

python
name = 'w3query' # name is a string
name = 'w3query' # name is a string

# 前的代码被执行, # 后的代码被解释器忽略

多行注释

Python没有提供单独的方式书写多行注释. 但是,可以通过其他方式来解决.

  1. 通过在每一行添加 # 来实现多行注释

例如

python
# This is a long comment
# and it extends
# to multiple lines
# This is a long comment
# and it extends
# to multiple lines

每一行都作为一条注释, 三行会同时被解释器忽略.

  1. 通过使用三个引号, 单引号 ''' 或者 """.

例如

python
''' This is a
example of
multi-line comments 
'''
''' This is a
example of
multi-line comments 
'''

之所以三个引号可以用来注释多行,是因为它包裹着多行字符串。而多行字符串是不可以赋值给任何变量,它会被解释器忽略掉。

注释作用

  1. 代码易读:代码注释是一个非常好的习惯, 优秀的代码注释为团队成员引用参考提供了极大的便利性.

  2. 调试记录:程序运维中报错, 我们可以将出错行注释掉,而不用删除。

例如

python
print('Python')

# print('Error Line )

print('Django')
print('Python')

# print('Error Line )

print('Django')

print('Error Line) 引起程序异常, 把它注释掉. 这样程序就可以正常运行.

小提示

注释应该记录为什么这样做, 而不是怎么去做。注释不应该为 糟糕代码 的补充说明。