本文介绍了Python编程中的注释功能，强调了其在代码理解中的重要性。注释分为单行注释（以#开头）和多行注释（用三引号包裹），用于解释代码的功能和意图，但不参与程序执行。文章还提供了注释的最佳实践，建议在代码复杂或不直观时使用注释，并避免过多无用的注释。通过比喻和示例，文章生动地展示了注释与代码的关系，以及如何编写清晰、有效的注释。最后，文章鼓励读者通过注释更好地理解代码，并提供了相关的学习资源。

文章内容

思维导图

常见问题

社交分享

> 如果你还没有安装好 Anaconda，可以暂时用线上工具替代一下，我推荐一个全球顶级 AI 社区开源工具（点击这里， + New Notebook，+ Add cell 就可以玩耍了）

今天我们要探索的是Python的魔法世界中的一个隐藏宝石——注释。

是的，你没听错，注释，那些看似默默无闻的文本，其实是编程的灵魂！

内容大纲

注释的基本概念

定义和作用

注释与代码的关系 2. 注释的类型

单行注释的用法和规则

多行注释的用法和规则 3. 注释的最佳实践

何时使用注释

如何有效地编写注释 4. 知识导图 5. 彩蛋

一、注释的基本概念

1. 定义和作用

想象我们化身成一位时间旅行者，穿越回去解读古代的秘密代码。注释就像是那些古老文本旁的译文，帮助我们理解代码的神秘含义。

它们解释代码做了什么以及为什么要这么做，但不参与任何实际的动作。

2. 注释与代码的关系

注释与代码的关系就像是导演与电影。导演不出现在电影镜头前，但他的指导无处不在。

注释在程序运行时是隐形的，但在代码的背后，它指导着我们理解程序的本质。

二、注释的类型

1. 单行注释

单行注释就像是微博或推特上的短句——简洁而有力。使用#开始，直到行尾。

示例：


# 这是一个单行注释，下面代码运行后会打印出 Hello, world!
print("Hello, world!")

2. 多行注释

而多行注释则像是一首散文诗，跨越多行表达所思所想。使用三引号’''或"""包裹起来。

示例：


"""
这是一个多行注释
可以跨越多行
"""

print("Hello, again!")

三、注释的最佳实践

1. 何时使用注释

注释像是调味品，恰到好处时能让菜肴美味，过多或过少都会破坏风味。当代码复杂或不直观时，加入适量的注释。

2. 如何有效地编写注释

好的注释应该像优秀的电影剧本——清晰、准确、引人入胜。避免废话，直接点题，让人一读就懂。

3. 错误示范

过多无用的注释就像是电影中不停闪现的广告，让人分心。比如：


# 打印 hello world
print("Hello, world!")# 这是多余的，因为代码已经很清晰了

4. 最佳实践

注释应该用来解释那些看起来不明显的部分。例如，解释一个复杂的算法决策，或标记一个未来可能需要修改的地方。


# TODO:优化这个循环，目前效率太低
for i in range(100000):
    # ...

记住，优秀的代码像是一首优美的诗，而注释则是那些让人回味无穷的注解。

四、知识导图

现在，让我们伴随着注释开始我们的编程之旅吧！走你~

五、请你欣赏

看看网络盛传的程序员注释，这得有多无聊（有才）啊，哈哈哈

—

学员提问

为什么你一开始讲注释不讲 Print 打印函数

福利:凭小报童购买截图，可享受现价7 折优惠加入[ 算法金学习陪伴群 ]

如: 现价 99 元，凭购买截图可享受 69.3 元加入

回 Python 编程基础 | 学习入口去 2.2.1 数字 | 入门必修

思维导图生成中，请稍候...

问题 1： 什么是Python中的注释？
回答： 注释是代码中的解释性文本，用于说明代码的功能或目的，但不参与实际执行。它帮助开发者理解代码的含义。

问题 2： 注释在代码中扮演什么角色？
回答： 注释类似于导演在电影中的作用，虽然不直接出现在执行过程中，但它指导开发者理解代码的逻辑和设计意图。

问题 3： 如何编写单行注释？
回答： 单行注释以#开头，直到行尾结束。例如：# 这是一个单行注释。

问题 4： 如何编写多行注释？
回答： 多行注释使用三引号'''或"""包裹，可以跨越多行。例如：

“”" 这是一个多行注释可以跨越多行 “”"


**问题 5：** 什么时候应该使用注释？  
**回答：** 当代码复杂或不直观时，应该使用注释来解释其功能或设计决策，避免在简单明了的代码中添加不必要的注释。

**问题 6：** 如何编写有效的注释？  
**回答：** 有效的注释应清晰、准确，避免废话，直接点题，帮助读者快速理解代码的意图。

**问题 7：** 什么是注释的错误示范？  
**回答：** 错误示范包括添加过多无用的注释，例如在显而易见的代码旁添加解释，如：`# 打印 hello world` 在 `print("Hello, world!")` 旁边。

**问题 8：** 注释的最佳实践是什么？  
**回答：** 注释应用于解释复杂的逻辑或标记未来需要修改的地方，例如：`# TODO: 优化这个循环，目前效率太低`。

**问题 9：** 为什么文章一开始讲注释而不是`print`函数？  
**回答：** 注释是理解代码的基础，它帮助开发者更好地阅读和编写代码，因此在学习具体函数之前，先掌握注释的使用更为重要。

**问题 10：** 如何加入算法金学习陪伴群并享受优惠？  
**回答：** 凭小报童购买截图，可以享受现价7折优惠加入算法金学习陪伴群。例如，现价99元，凭截图可享受69.3元加入。

2.1.1 注释 | 入门必修 | Py基础