编写代码不能不写注释

        有时候，一件小的事情，未必小。写代码不写注释就是这样的一件小事，但是这个现象显示的深层道理一点也不小。

 

        写了这么多年了代码了，见过很多人还是规规矩矩的将代码写好，而且并写一个高质量的注释来让代码更加饱满；也见过很多人写起来代码行云流水，潇潇洒洒，但是一句注释也没有；所以我就经常看到这样的现象和听到这样的话语：

 

         Xxx，搞毛线啊，连个注释都不写，他摇摇屁股走人了，把我给坑死了。。。。

         Xxx，你自己写的代码，你都不知道是什么意思了啊，你搞笑呢吗。。。。。

         Xxx，你解决个bug这么慢啊，怎么回事，把你代码发过来我看看，。。。。。。过了好长时间。。。。哥，我真看不了你的代码，你的代码写的太好了，连个注释都没有，怎么解决bug，费死牛劲了。。。。

         Xxx，你学代码学习人家yyy，你看看人家代码写的，别人看是享受；你的代码，别人看是想哭。。。。

 

        各种现象，都会出现，这些例子都从方面说明了写注释的重要性，而且好的代码就应该有注释辅佐，才能更加有艺术效果。

 

        其实，从历史的角度来看，注释这个神奇的东西就已经存在了。我们读的古书、古诗还有古文都会有注释的。这些注释目的很简单有助于读者对这段文字的理解。

 

        在n多个古人和经验教训的归纳总结，形成了软件工程这门科学知识。软件工程这门课程给我提供了编程道路的一盏明灯，它告诉我们编程是一件什么样的工作，做什么，怎么做。所以软件工程的每一本教材都告诉我们写代码要加注释，而且要学会加高质量的注释。

 

        不管从历史，还是从软工来看，代码也就应该有注释来搭衬，才能彰显代码的艺术效果。这样才能让读者明白代码作者的编程意图，也为日后读这段代码做了很好的铺垫，当这段代码出现问题的时候，我们能够很快的将问题找到并解决。

 

        但是很多人还是将自己处在一个创造者的姿态，不服从历史的教训，不听从软工的教导，写代码就不加注释，所以这些人一定会遇到我文章一开的几种现象，到时候他们就知道不写注释是有多么不好了。亲身体会才能体会到痛和自己埋下的祸根自己受就是这样的道理。

 

        所以要想写出高质量的代码，写注释不一定行，但是不写注释一定不行。写注释是前提，随着写的量多了一定会达到质变（不光是注释还有代码）。

 

        所以编程不是一件仅写代码的事情，除了代码，还有很多，其中就有注释。。。。。

 

        推荐：

           代码质量随想录---作者：爱飞翔

 

　　   代码质量随想录（一）：可读是王道

　　   代码质量随想录（二）：必也正名乎

　　   代码质量随想录（三）：名字好，误会少

 代码质量随想录（四）：排版，不只是为了漂亮

 代码质量随想录（五）：注得多不如注得巧