Python注释:给代码加说明

写代码的时候，我们不只是写给电脑看。

也是在写给以后的自己、同学和老师看。

如果一段代码过几天再打开，自己都看不懂了，就会很难修改。

这时候，注释就很有用。

注释像代码旁边的小便利贴。

它告诉人：

这一行代码是做什么的。

电脑看到注释时，不会把它当作命令执行。

一、什么是注释

Python 里，最常见的注释从 # 开始。

# 后面的内容，是写给人看的说明。

运行结果：

第一行没有被输出。

因为它是注释，不是代码命令。

电脑真正执行的是第二行 print("你好，Python")。

二、注释像课堂旁白

上课时，老师可能会说：

“这一行是用来显示结果的。”

代码里的注释，也是在做类似的事。

运行结果：

这里的两行注释，帮助我们看懂：

name = "小明" 是在保存姓名。

print(name) 是在输出姓名。

三、注释可以写在代码上方

初学时，建议把注释写在代码上方。

这样最清楚，也不容易把一行写得太长。

运行结果：

这种写法很适合刚开始学习的同学。

先说明目的。

再写代码。

四、注释也可以写在代码后面

有时候，一行代码很短，也可以把注释放在后面。

运行结果：

不过要注意：

如果后面的说明太长，手机上阅读时容易换行混乱。

所以公众号微文和课堂练习里，更推荐把注释放在代码上方。

五、不要把注释写成另一段作文

注释不是越多越好。

好的注释应该短。

说明关键目的就够了。

下面这样比较合适：

运行结果：

如果每一行都写很长的解释，反而会让代码变得难读。

注释要帮助理解。

不要挡住代码本身。

六、注释不能和代码说反话

注释写错，比没有注释更麻烦。

看下面这段：

运行结果：

这段是正确的。

如果注释写成“计算平均分”，就会误导别人。

所以写完注释后，要检查：

注释说的事，和代码做的事是不是一致。

七、课堂小任务

请写一个自我介绍小程序。

要求：

每一小段代码上方加一行注释。

代码可以参考下面的结构：

运行结果：

你可以把姓名和年龄改成自己的。

也可以再加一段兴趣爱好。

八、今天记住三句话

注释从 # 开始。

注释是写给人看的，电脑不会执行。

好的注释要短、准、清楚。

下一节，我们学习 Python 里很重要的“缩进”。

缩进就像代码的队形。

队形对了，程序才不容易乱。