关于接受离职同事代码管路注释

不需要注释便能让别的开发人员轻松地阅读下来的代码才可以称得上是高质量的代码

清谈代码注释：

 

      在项目开发时难免会遇到新人接手的情况，在这时如果你的代码质量一般或者说是代码风格与此人相差较多，那么此人在阅读时必定会遇到很多麻烦；我自己也见到过许多拼音缩写的函数名甚至中英双打还没有注释的情况，这时我只能说呵呵了，只能硬着头皮尽可能的把代码读下来，但是要知道这是一个很恶心的过程，当然如果根本不可能在一起工作的人你非得要求他怎样怎样那也是没有意义的，自己不注重细节，作为路人的我只能呵呵一笑。

      

  有时候，我们的开发者要完成某个功能的编码实现，或许灵光一闪，犹如行云流水，一气呵成，看着长长的整洁的代码总是忍不住津津乐道，就是懒得给这代码添上几行注释。过几天，或者过了一段时间之后，代码需要改动，还得花时间重新理解这段代码，改动需要10分钟足矣，但是阅读这段代码可能需要花上半个小时或者半天的时间，如果这代码是由别的程序员来阅读，花的时间必定会更长。不写注释，不利于日后工作的进展，也不利于日后工作的交接。

百度、google了一下都没有详细说程序注释的意义相关的文章，只搜到一些不写注释带来的影响，诸如此类：

 

 

       给代码写上工整的注释是一个优秀程序员的良好习惯。工整简洁的代码未必就有较高的可读性，在一些业务比较繁琐，参数比较多的函数中，阅读代码的人会在各种参数的用法中纠缠不清，但是如果在参数或者业务操作的代码旁加上工整的注释，可以让既有的代码脉络清晰，更加有血有肉。如下图所示：

 

：

 

   

      注释是程序员个性的反映。大家都有各自的编码习惯和注释风格，喜欢在注释里面署名的程序员，个性比较张扬，无论是对生活还是对工作都是乐观积极，团队中的活跃分子；喜欢用符号框住注释的程序员，拥有谦虚得体的个性，工作生活中不骄不躁，传递着正能量；喜欢把注释围成图案的程序员，内心想法丰富多彩，无论是工作还是生活都不缺乏艺术范。可见，注释也是程序员得以展现自我的舞台。

 

       注释有利于节约公司的资源。程序员的工作很多时候会交接给新的职员来进行，新职员往往会耗上一段较长的时间去阅读代码，这个过程难免会经常询问同事有关问题，间接或直接影响到同事工作状态。注释可以大大降低问题的发问率，并且引导新职员去理解代码，同时节省了时间，而时间就是金钱。

看过软件工程相关教材的都有所了解，几乎每一本教材都告诉我们写代码要加注释，并且要学会高质量的注释，因为代码不仅仅是用来执行的，它还是用来给别人看的。好的代码加上高质量的注释，使得程序尽显优雅，读的人赏心悦目，何乐为不为呢？

 

                                                                                                                                                                           纯属个人领悟，无针对任何人之意~

                                                                                                                                                                                             2017 4.23

                                                                                                                                                                                                        faker