Python注释：给代码“写说明书”，让程序会“说话”

在大多数编程语言当中，注释一项很有用的功能，前面写过的程序都很简单，但是随着不断的学习，代码量越来越大，越来越复杂，就应该向其中添加说明，对你解决问题的方式进行一个大致的阐述。如果把代码看作我们的菜谱，注释就是菜谱旁边的小贴士和注意事项

注释就是嵌入在代码当中的解释性文字，Python解释器会完全忽略他们，就好比老师在批卷子的时候只会看你的答案，而不会看你旁边写的草稿。但是对于读者来说，大大提高了代码的可读性

一、写注释的理由：

为了别人：让团队成员理解你的代码

为了自己：防止未来忘记为什么要这样写（别到时候只有老天能看懂了哈哈哈）

为了质量：通过写注释，你会重新思考代码逻辑

二、写注释的建议

1.说“为什么”而不说“是什么”

不要写：这里把 x 加 1

应该要写：“递增计数器，用于统计数量”

2.简洁明了

用简洁的语言，不说多余废话

3.保持更新

代码改了注释也要改

4.有些情况不需要注释

代码已经很清楚了，或者变量名明显

这里和大家分享一个调试小技巧，在代码进程出现问题的时候，可以先把疑似问题的地方注释掉，以此类推，看每一次代码运行的结果来判断是哪一行出现了问题

好的注释就像地图上的标识，能帮你快速找到方向，但不会把整个地图都写满字

写注释就是：用简单的话，解释为什么要这样写代码