编码为何要加注释

无规矩不成方圆，无论我们做任何事情，都必须遵循一定的规矩。对于一个程序员来说，编程规范可谓是重中之重。当然，不要狭义的把编程规范仅仅理解成是编码规范，整个软件开发过程都是需要规范的，软件工程本身就是一种规范。在这里，我想重点说一下编码规范中的注释。

在编码规范的世界里，注释扮演着一个相当重要的角色。那么，注释到底怎么重要了呢？

 

首先，从编码者自身的角度考虑。

我们完成一个项目，一般来说不是一天两天就完成了，经常是需要几周，几个月，甚至是几年。想象一下，如果你没有写注释，现在让你看你几个月之前写的代码。你能一下子看懂多少？你需要多长时间去回想自己当时的思路？这不是浪费时间嘛！而这些都是可以通过写注释来弥补的。

 

其次，从别人的角度考虑。

我们写代码，不仅仅是给自己看的，更重要的是让别人也能看懂。在软件开发的过程中，维护占大部分比例。而维护工作者可能不是当初编写代码的人。你可能是高手，编写代码的能力很高，本来应该是一天的工作，结果，你没有写注释，半天完成了。表面上看，似乎你的工作效率挺高的。但是，你知道嘛，后期维护的人可能需要用两天，甚至更长的时间去理解你写的代码。这就是好多人不愿意做维护工作的原因。我们总说，作为一个合格的程序员，要时时刻刻为客户着想，难道我们就不需要为和我们一起奋战的同胞们想一想吗？

 

最后，从公司的角度考虑。

你不写注释，一天的工作半天完成了，为公司节省了半天时间。可是，到维护的时候，维护人员可能花了两天的时间才看懂你的代码。可想而知，你为公司带来了多大的“利益”！试问，如果你是公司老板，你会雇佣这样的程序员吗？肯定不会！那么，这样的程序员将永远被定义为码农。码农啊，你懂吗？

 

总之，注释很重要，它是程序员之间沟通的桥梁。对了，强调一下，清晰的代码格式、规范的命名等是比注释更好的注释。

 

为了我们将来不成为专业码农的，从现在开始注重编程规范，认真编写注释吧。让“为‘客户’着想”的想法常驻心中。