删除额外的注释 敏捷开发(一)

 

 

 

    为什么要删除额外的注释?其实,加注释本身是一个很正确的事情,因为注释可以让人更容易的理解代码.因为
程序员觉得光光代码,可能还不能让人完全理解.而问题就在于,因为常常没有把代码写清楚,所以我们就找了一个捷径,那就是写上注释.注释不够清楚,再写上文档.好,这样子,程序可以让人看得懂了吧.而这样造成的结果就是,没有人愿意去好好的组织代码,让代码清楚起来,因为他们觉得加上注释就好了.之后,代码更新了,可是程序员却常常忘了去更新注释(我们不得不承认,这种情况经常发生,这点,再好的软件工程,都会有这种问题的存在).过了一段时间,这些过时的注释不仅不能让代码更容易懂,反而会误导了读代码的人.到了最后,我们剩下的东西就是:本身就不清晰的代码,混上一些不正确的注释.

 

    因此,不管任何时候,当我们要加注释的时候,我们应该再三的想想:我的注释能不能转化在代码里面,让代码跟注释一样的清晰?而大多数情况下,我们得到的答案都是:能!

 

    每一个注释都是一个改进代码的好机会!我们不能说,注释少的代码就是好代码.但我们绝对可以说,包含太多注释的代码,绝对不是高质量的代码.