注释是写代码的良好习惯，它不仅能提高代码的可读性，还能方便自己和他人理解代码。掌握如何添加清晰、有用的注释，是成为优秀开发者的重要一步！
什么是注释？
当我们写代码时，注释就像代码的“旁白”，它用来解释这段代码是做什么的，或者给未来阅读代码的人（可能是你自己）一些提示。注释不会被计算机执行，它们只为人类服务。就像书中的脚注、笔记，让代码更加清晰易懂。
为什么需要注释？
- 帮助理解代码：即使是你自己写的代码，过段时间也可能忘了它的具体功能。
- 方便团队协作：你的同事或合作伙伴需要快速了解代码的意图。
- 提高代码可维护性：注释让代码的逻辑清晰明了，后续修改更容易。
一句话：注释是写给“人”看的，而代码是写给“计算机”跑的。
如何在 Python 中添加注释？
Python 中的注释有两种形式：
1. 单行注释
你可能在之前的学习中已经注意到。我们在一些代码旁边使用了井号（ # ）。这些用井号（ # ）开头的内容就是注释。井号后的所有内容都不会被运行。
# 这是一个单行注释
print("Hello, World!") # 这是一个内联注释
print("Hello, World!") # 这是一个内联注释
2. 多行注释
用三对单引号（ ''' ）或三对双引号（ """ ）括起来的内容就是多行注释。
'''
这是一段多行注释。
它可以用来写长段说明，比如代码的功能、作者信息等。
'''
print("Hello, World!")
这是一段多行注释。
它可以用来写长段说明，比如代码的功能、作者信息等。
'''
print("Hello, World!")
添加注释的最佳实践
1. 解释代码的目的，而不是重复代码的内容
- 不推荐：
x = 10 # 将x赋值为10
- 推荐：
x = 10 # 初始分数设置为100
2. 简洁明了
- 注释不要写得太长，只需要清楚表达意图即可。
- 避免写废话，例如：
# 计算两个数的和
result = a + b
result = a + b
3. 为复杂逻辑添加注释
如果代码逻辑比较复杂，一定要添加注释帮助理解：
# 如果用户输入的分数大于100，则自动设置为100
if score > 100:
score = 100
if score > 100:
score = 100
4. 在文件顶部添加总体说明
说明文件的功能、作者和创建日期等：
'''
功能：计算用户输入的数字总和
作者：Python 学习者
创建日期：2024年11月16日
'''
功能：计算用户输入的数字总和
作者：Python 学习者
创建日期：2024年11月16日
'''
5. 随代码更新而更新注释
如果修改了代码，一定要记得同步更新注释，避免产生误导。
练习：
现在请尝试在上节练习中的加法、减法、乘法和除法计算器的脚本代码中添加必要的注释。
AI 助教
提示：您可在此提出学习中遇到的问题。回答由 AI 生成，可能存在错误，请注意甄别。