查看全课大纲（第 5 / 51 节）

注释有什么用，怎么写？

约 6 分钟

小象实战讲义 · Python 编程从入门到实践

在编写代码时，我们经常需要加入一些说明文字，帮助自己或他人理解代码的意图。这就是注释。本节将学习 Python 中注释的两种主要写法，以及如何高效地使用 IDE 工具来管理注释。这是编写清晰、可维护代码的第一步。

什么是注释？

注释是我们在代码中插入的自然语言（如中文、英文），用于描述代码的逻辑和功能。它的核心目的是让人能读懂代码，而不是让 Python 解释器去执行。

写注释的主要好处是便于代码的维护。当项目迭代、代码量增大，或者其他人需要阅读你的代码时，清晰的注释能帮助他们快速理解代码的意图，从而更容易进行后续的开发和修改。

Python 支持两种主要的注释方式：单行注释和多行注释。

单行注释以井号 # 开头。# 之后、本行结束之前的所有内容都会被 Python 解释器忽略。

# 这是一行注释，打印问候语
print("Hello, Python!")

Hello, Python!

如果你想注释多行，可以在每一行的前面都加上 #。

# 这是第一行注释
# 这是第二行注释
print("这行代码会被执行")

这行代码会被执行

对于大段的说明文字，Python 提供了更便捷的多行注释写法：使用三个连续的单引号 ''' 或三个连续的双引号 """ 将内容包裹起来。

'''
这是一个多行注释。
它使用了三个单引号。
中间的所有内容都不会被执行。
'''
print("程序从这里开始执行")

程序从这里开始执行

三个双引号的用法完全相同：

"""
这也是一个多行注释。
它使用了三个双引号。
常用于文件开头，描述模块功能。
"""
print("Hello World")

Hello World

注意：是三个单引号 ''' 或三个双引号 """，而不是六个单引号或双引号。

在集成开发环境（IDE）中，通常有快捷键可以快速注释或取消注释代码，这能提高效率。以常见的 Spyder IDE 为例：

这些快捷键的本质是在你选中的每一行代码前添加或移除 #，而不是使用 ''' 或 """。对于大段的临时代码调试，使用快捷键非常方便。

请写一段代码，包含一个单行注释和一个多行注释。单行注释说明下面代码的功能是计算两个数的和，多行注释用于说明整个代码文件的目的（例如：“本文件用于演示基本数学运算”）。然后打印出计算结果。

👉 点击查看参考答案

思路：先写多行注释描述文件，再用单行注释说明具体操作，最后是执行计算的代码。

"""
本文件用于演示Python中的基本数学运算，
包括加法操作。
"""

# 计算两个整数的和
a = 5
b = 3
sum_result = a + b
print("两数之和为：", sum_result)

两数之和为： 8

错误写法	现象或报错	原因	正确写法
用全角输入法输入 `＃` 当作注释符号	`SyntaxError: invalid character '＃' (U+FF03)`	Python 只识别半角的 `#`，全角 `＃` 不是合法的程序字符。	切换到半角输入法，用 `#` 开头写注释。
把 `print("Hello")` 这一行也用 `#` 注释掉，却仍期待它执行	程序不报错，但这一行没有任何输出	`#` 之后到行尾的内容都会被解释器忽略，注释掉的语句不会执行。	需要执行这一行就去掉开头的 `#`。

注释是给人看的：用于解释代码逻辑，提高可读性和可维护性，程序运行时会被忽略。
单行注释用 #：# 之后到行尾的内容都是注释。
多行注释用 ''' 或 """：用三个连续的单引号或双引号包裹多行注释内容。
善用 IDE 快捷键：如 Ctrl + 1（注释/解注释当前行）、Ctrl + 4（注释整块）和 Ctrl + 5（解除整块注释），可以快速注释或取消注释代码，方便调试。
注释要说明代码的逻辑和功能：写注释是为了让人读懂代码、方便后续维护，不是重复一遍代码的字面意思。

—— 小象教研组