Python 注释

在 Python 中，给一些关键代码作注释是非常有必要的。注释的好处有很多，比如方便理解、方便查找以及方便项目组里的其他开发人员了解你编写的代码，而且也方便你以后对自己的代码进行修改。

Python 的注释，可以分为以下 2 种情况。

• 单行注释
• 多行注释

Python 单行注释

在 Python 中，我们可以使用 “#” 来创建单行注释。当注释的内容比较少（比如只有一行）时，我们可以使用单行注释的方式。

语法：

# 单行注释内容

说明：

在实际开发中，并不是什么地方都要加上注释。一般情况下，我们只会对一些关键功能的代码进行注释。

示例 1：Python 单行注释

# 定义变量
name = 'Jack'
# 打印结果
print(name)

运行结果如下。

Jack

分析：

在使用单行注释时，比较好的一个规范是：“#” 与注释内容之间应有一个空格。虽然没有这个空格也没问题，不过加上空格会更加直观规范一些。

Python 多行注释

Python 并没有像 C++、Java 等语言中提供的 “专用” 的多行注释语法，它的多行注释同样是使用 “#” 来实现的。

语法：

# 多行注释内容
# 多行注释内容
# 多行注释内容

示例 2：Python 多行注释

# 定义一个变量
# 并且打印结果
name = 'Jack'
print(name)

运行结果如下。

Jack

分析：

或者你也可以使用多行字符串来实现多行注释的目的，比如：

'''
定义一个变量
并且打印结果
'''
name = 'Jack'
print(name)

由于 Python 会自动忽略未分配给变量的多行字符串，此时多行字符串的功能就相当于多行注释了。

使用注释来阻止代码执行

在调试代码时，注释非常有用。比如我们写了一段代码，发现并没有达到预期效果。如果想要保留该代码，以便在尝试使用其他方案无法解决时，又想基于这段代码进行再次尝试，此时就可以将该代码段进行注释。这样既可以达到保留的目的，又不会影响程序其他部分的执行。

在 VSCode 中，我们可以使用这样的方式来将一个代码段注释：选中代码，然后使用 “Ctrl+/” 组合键。如果想要解除已经注释的代码，可以先选中已被注释的代码，然后再使用 “Ctrl+/” 组合键即可。