跳到主要内容

Python注释

提示
  1. Python注释简介:注释是程序中的文本,帮助理解代码但不被执行。
  2. 注释类型:Python支持单行和多行注释,使用#和三引号。
  3. 注释作用:注释用于解释代码目的,便于理解和调试。

在计算机编程中,注释是我们用来使代码更易于理解的提示。

解释器完全忽略注释。它们是为其他程序员准备的。例如,

# 声明并初始化两个变量
num1 = 6
num2 = 9

# 打印输出
print('这是输出')

在这里,我们使用了以下注释,

  • 声明并初始化两个变量
  • 打印输出

Python中的注释类型

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

  • 单行注释
  • 多行注释

Python中的单行注释

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

# 创建一个变量
name = 'Eric Cartman'

# 打印值
print(name)

输出

Eric Cartman

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

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

我们也可以将单行注释与代码一起使用。

name = 'Eric Cartman' # name是一个字符串

这里,#之前的代码将被执行,而#之后的代码将被解释器忽略。

Python中的多行注释

Python没有提供编写多行注释的单独方式。然而,有其他方法可以解决这个问题。

我们可以在多行注释的每一行开头使用#。例如,

# 这是一个长注释
# 它延伸至
# 多行

这里,每行都被视为一个单独的注释,并且它们都被忽略。

另一种方法是使用三引号,'''"""

这些三引号通常用于多行字符串。但如果我们不将其分配给任何变量或函数,我们可以将其用作注释。

解释器会忽略没有分配给任何变量或函数的字符串。

让我们看一个例子,

''' 这也是
多行注释的
完美例子 '''

这里,多行字符串没有分配给任何变量,因此被解释器忽略。尽管它技术上不是多行注释,但它可以被用作一个。

Python注释的使用

1. 使代码更易于理解

如果我们在代码中写注释,将来参考时会更容易。

同时,其他开发人员也会更容易理解代码。

2. 调试时使用注释

如果我们在运行程序时遇到错误,我们可以将引起错误的代码行注释掉,而不是删除它。例如,

print('Python')

# print('错误行')
print('Django')

这里,print('错误行')导致了一个错误,所以我们将其改为注释。现在,程序可以无错误地运行。

这就是注释可以成为一个有价值的调试工具的方式。

注意:始终使用注释来解释我们为什么这样做,而不是我们如何做。注释不应该用来替代解释糟糕编写的代码。