Python注释
注释是编程中非常重要的部分，它允许我们在代码中添加解释性的文字，帮助我们自己和他人理解代码的功能。
为什么需要注释？
想象一下你写了一篇精彩的作文，但没有标题和段落标题。别人读起来会很困难！注释就像代码中的标题和笔记，它们让代码更容易理解。
注释的作用
注释在编程中有几个重要作用：
- 解释代码功能：说明代码做什么以及为什么这样做
- 调试助手：暂时禁用代码而不删除它
- 团队协作：帮助其他程序员理解你的代码
- 学习笔记：记录你的学习心得和重要提醒
好的注释 vs 不好的注释
学习如何写有用的注释同样重要：
好的注释
# 计算圆的面积
radius = 5.0 # 圆的半径
# 公式：面积 = π * 半径的平方
area = 3.14159 * radius ** 2
print("圆的面积是:", area)
radius = 5.0 # 圆的半径
# 公式：面积 = π * 半径的平方
area = 3.14159 * radius ** 2
print("圆的面积是:", area)
优点：
- 解释代码的目的
- 说明公式的含义
- 变量用途清晰
不好的注释
radius = 5.0 # 设置半径为5.0
area = 3.14159 * radius * radius
print(area) # 打印面积
# 现在程序结束了
area = 3.14159 * radius * radius
print(area) # 打印面积
# 现在程序结束了
缺点：
- 注释只是重复代码
- 没有提供额外信息
- 无用的结束注释
为什么注释很重要？
好的注释可以让你的代码：
- 更容易理解 - 几周或几个月后回头看，你还能明白代码做什么
- 便于分享 - 其他人能更快理解你的代码
- 减少错误 - 清晰的注释有助于避免错误
- 学习进步 - 记录你的思考过程，便于复习
注释的创意用法
除了解释代码，注释还可以有其他用途：
# ======================
# 学生成绩管理系统 V1.0
# 创建日期: 2023-10-15
# 作者: 张小明
# ======================
# TODO: 添加保存成绩功能
# FIXME: 除法运算存在精度问题
# 重要提示：
# 在修改代码前请先阅读文档
# 调试模式
# debug = True # 取消注释以启用调试
debug = False
# 学生成绩管理系统 V1.0
# 创建日期: 2023-10-15
# 作者: 张小明
# ======================
# TODO: 添加保存成绩功能
# FIXME: 除法运算存在精度问题
# 重要提示：
# 在修改代码前请先阅读文档
# 调试模式
# debug = True # 取消注释以启用调试
debug = False
注释小贴士
- 保持注释简洁明了
- 注释要随代码更新
- 避免过度注释显而易见的代码
- 使用TODO标记需要完成的工作
- 用注释分隔代码块
常见问题
注释会被Python执行吗？
不会！注释完全被Python忽略，不会影响程序运行速度。
注释应该写多少？
一个好的经验法则是：注释数量应该占代码总量的20%-30%，但更重要的是质量而非数量。
练习时间
练习1：添加注释
给下面的代码添加合适的注释：
temp_c = 25.0
temp_f = (temp_c * 9/5) + 32
print("摄氏温度:", temp_c)
print("华氏温度:", temp_f)
temp_f = (temp_c * 9/5) + 32
print("摄氏温度:", temp_c)
print("华氏温度:", temp_f)
# 摄氏温度值
temp_c = 25.0
# 将摄氏温度转换为华氏温度
# 公式：华氏度 = (摄氏度 × 9/5) + 32
temp_f = (temp_c * 9/5) + 32
# 打印摄氏温度
print("摄氏温度:", temp_c)
# 打印华氏温度
print("华氏温度:", temp_f)
temp_c = 25.0
# 将摄氏温度转换为华氏温度
# 公式：华氏度 = (摄氏度 × 9/5) + 32
temp_f = (temp_c * 9/5) + 32
# 打印摄氏温度
print("摄氏温度:", temp_c)
# 打印华氏温度
print("华氏温度:", temp_f)
练习2：代码解释
阅读下面的代码，添加注释解释每行代码的作用：
num_list = [12, 45, 78, 34]
total = 0
count = 0
for num in num_list:
total += num
count += 1
average = total / count
print("平均值:", average)
total = 0
count = 0
for num in num_list:
total += num
count += 1
average = total / count
print("平均值:", average)
# 创建一个数字列表
num_list = [12, 45, 78, 34]
# 初始化总和为0
total = 0
# 初始化计数器为0
count = 0
# 遍历列表中的每个数字
for num in num_list:
# 将当前数字加到总和中
total += num
# 计数增加1
count += 1
# 计算平均值：总和/数量
average = total / count
# 打印计算结果
print("平均值:", average)
num_list = [12, 45, 78, 34]
# 初始化总和为0
total = 0
# 初始化计数器为0
count = 0
# 遍历列表中的每个数字
for num in num_list:
# 将当前数字加到总和中
total += num
# 计数增加1
count += 1
# 计算平均值：总和/数量
average = total / count
# 打印计算结果
print("平均值:", average)
重要提示
记住这些关于注释的重要事项：
- 注释是写给人看的，不是给计算机的
- 好的注释解释为什么，而不仅仅是是什么
- 保持注释简洁但信息丰富
- 注释应该与代码同步更新
- 不要用注释解释明显的代码
Python中的注释类型
使用井号(#)开头的注释：
print("你好，世界！") # 也可以写在代码后面
特点：
使用三个单引号或双引号包裹的注释：
这是一个多行注释
可以跨越多行
常用于函数或模块的说明
'''
"""
这也是多行注释
使用双引号效果相同
"""
特点：