在代码里面, 那些以#开头的单行文字, 或者是被三引号包裹起来的文本内容, 这些统统都叫做注释。注释有一个非常明显的特点, 那就是它只会被人用来阅读, 主要作用就是解释说明, 等到解释器去运行代码的时候, 会直接把它忽略掉, 完全不会参与程序的执行过程, 当然也不会对代码的运行效率造成任何影响。
许多新手学员往往觉得注释这个东西可有可无, 所以在写代码的全过程里, 几乎从来就不添加任何解释性的说明，这其实是一个对于长期的学习来说非常不利的坏习惯, 而且很有可能还会影响到后续找工作以及和同事之间进行团队协作的情况。
现在, 你写完代码之后, 对整体的逻辑是非常清楚的。可是, 间隔几周之后再回头翻看, 很容易就会遗忘代码的设计思路, 甚至都看不懂自己写的代码了。
如果遇到一些复杂的循环, 或者是数据处理逻辑, 没有注释的话, 阅读难度是非常高的。往往需要花费大量的时间, 去重新梳理逻辑。而清晰的注释, 相当于给自己留下了阅读的线索, 能够快速地回忆起代码的功能与设计思路。
如果以后要参与团队协作的话, 注释的价值会得到更加明显的放大。
因为每个人在编程的时候思路不一样, 代码风格也不同, 所以就导致了一段缺乏说明的代码会让其他的开发者很难快速看懂功能到底是怎么回事, 而且在修改和调试的时候又极容易产成理解上面出现的偏差, 这就会衍生出新的 bug, 从而降低了团队协作的效率。
所以说规范的注释作为团队协作基础这个说法是成立的, 它的确能让维护代码的事情会变得更容易一些。
很多人容易掉进一个坑里, 他们觉得写注释就是把代码表面上的动作再复述一遍, 打个比方来说, 如果写了一行像`a = 1 # 将 a 赋值为1`这样的语句, 那这种注释简直就是毫无用处, 它不仅不能带来好处, 反而还会给代码增加没必要的麻烦和重复内容。
好的、高质量的注释呢, 它应当去解释清楚为什么代码要这么来写, 要把背后的业务需求交代明白, 把特殊的限制条件说清楚, 还要提醒大家注意那些潜在的陷阱和问题, 总之不要干那些只复述一眼就能看明白的代码这种无聊的事情。
把它分成单行注释和多行注释这两种类型, 其中使用的是#符号的单行注释比较适合做一些简短的标注工作, 而那种使用三个引号包裹起来的多行注释通常被用在文件的开头部分或者是函数的开头部分里面去, 主要是用来对整个功能进行一个全面的描述。
坚持写代码中的注释这件事, 它最根本的性质呢, 它就是对你自己思路进行一次梳理的一个过程, 在当你发现你自己很难去使用那种简短的文字来向别人说明某一段特定的代码它的实际作用到底是什么意思的时候, 你其实就可以知道这是因为你自己的内在逻辑还并没有达到足够清晰的地步了, 所以你应当要在最早期就养成一种去规范地书写那些注释的良好的习惯, 不管是你现在自己在自学并且做一个项目的这种阶段, 还是说你未来要去求职并且参与到实际开发工作里面的时候, 这是一个能够给你加分的一项内容, 它能够非常鲜明地体现出你的那种专业的素养, 进而能让你的那些代码变得更加的标准和更加具有可读性的。
