Python 注释

在上一篇教程中，您学习了如何编写您的第一个Python 程序。现在，让我们来学习 Python 注释。

重要！：我们在本系列教程的早期引入注释，因为我们将在接下来的教程中使用它们来解释代码。

注释是我们添加到代码中的提示，以使其更易于理解。Python 注释以 # 开头。例如，

# print a number
print(25)

这里，# print a number 是一个注释。

注释会被代码编辑器完全忽略且不执行。

重要：本教程的目的是帮助您理解注释，因此您可以忽略程序中使用的其他概念。我们将在后面的教程中学习它们。

单行注释

我们使用井号 (#) 符号来编写单行注释。例如，

# declare a variable
name = "John"

# print name
print(name)    # John

在上面的例子中，我们使用了三个单行注释

• # declare a variable
• # print name
• # John

单行注释从 # 开始，并延伸到行尾。我们也可以在代码旁边使用单行注释。

print(name)    # John

注意： 记住应用注释的键盘快捷键。在大多数文本编辑器中，如果您使用的是 Windows，它是 Ctrl + /；如果您使用的是 Mac，则是 Cmd + /。

多行注释

与 C++ 和 Java 等语言不同，Python 没有专门的方法来编写多行注释。

但是，我们可以通过在每行开头使用井号 (#) 符号来达到同样的效果。

让我们看一个例子。

# This is an example of a multiline comment
# created using multiple single-line commenced
# The code prints the text Hello World
print("Hello, World!")

我们也可以使用多行字符串作为注释，就像这样

'''This is an example 
of multiline comment'''
print("Hello, World!")

输出

Hello World

注意： 请记住，您将在接下来的教程中学习这些编程概念。现在，您只需关注注释的用法。

使用注释阻止代码执行

在调试代码时，注释非常有用。

如果我们在运行程序时遇到错误，可以不删除代码段，而是将它们注释掉以阻止执行。例如，

number1 = 10
number2 = 15

sum = number1 + number2

print("The sum is:", sum)
print("The product is:", product)

在这里，代码会抛出一个错误，因为我们没有定义一个 product 变量。我们可以不删除导致错误的行，而是将其注释掉。

例如，

number1 = 10
number2 = 15

sum = number1 + number2

print("The sum is:", sum)
# print('The product is:', product)

输出

The sum is 25

这样，代码就可以无错误地运行。

我们已经使用注释解决了这个错误。现在，如果您将来需要计算 product，可以取消注释。

注意： 这种方法在处理大文件时非常方便。我们可以不删除任何行，而是使用注释来确定哪一行导致了错误。

为什么要使用注释？

我们应该使用注释

• 为将来参考，因为注释使我们的代码更具可读性。
• 用于调试。
• 用于代码协作，因为注释可以帮助同行开发者理解彼此的代码。

接下来，我们将开始学习 Python 编程的基本概念。