对于大多数像我一样的java初学者,都会认为可以编写出大段大段代码的人都是很牛逼的大神,所以有时也会向大神看齐,去编写一大堆代码,而且认为越是纯代码,越是别人看不懂,就越像一个大神。因此,大多数初学者都会养成一个编程的坏习惯——只有代码,没有注释!在这里,我就我个人对注释的认识做一个记录。

一、没有适当注释的弊端

1.当你编写了大段大段的代码后,遇到了逻辑上的错误,你就需要从头分析,而且是从头分析代码!因为你没有注释,所以你只能从代码中查找逻辑上的错误,这样工作效率就会很低。

2.当你编写完一个程序,过了N段时间,在编写另一个程序的时候,突然发现需要回头看看以前那个程序,来完善你的程序或思路,你就会面对之前那个程序头大,因为N段时间的打磨,已经让你对之前那个程序的思路或代码十分模糊了,重新读代码?好吧,工作效率就不言而喻了。

3.一个好的程序员,并不一定可以完成一个好的项目,真正的好项目,却需要一组好的程序员。所以,当你作为一个好的程序,只编写好自己的程序,不加适当的注释,就会使得你的程序在其他程序员看来是难以理解的,这会导致你成为一个不合格的组员。一个没法很好合作的组员,就像一个没法让系统很好调用的函数,只会影响整个系统的效率。

4.在一款软件的整个生命周期中,代码的维护占有比较重的比例,因为谁也不敢保证自己的软件是完美的。但具调查,几乎没有一款成功的软件是在整个生命周期中都由软件的开发人员来维护。如果你是一个软件的维护人员,你是愿意拿着一款纯代码的软件来连蒙带猜的分析开发人员编写代码的意图呢,还是希望有合理的注释让你很快的理解代码找到bug?我想答案是显然的。至于在这里没有合理注释对效率的影响……你懂的。

二、如何编写合理的注释

1、在java中,使用javadoc(注释方法/**……*/)是很不错的选择,因为它对编写API的人来说帮助太大了。javadoc要求你在源代码、类、函数前一行添加注释,这样的注释也能使你的程序结构显得比较清晰。

2、对于块注释:/*……*/,一般用于多行注释,主要是对某个函数或某段算法的简要说明,javadoc是不会解析它的。

3、单行注释://,一般适用于对某个变量的说明,当某一部分出现多个单行注释时,要求多个注释开头对其,增加注释的可读性。

4、合理的注释,就意味着适量,并不是注释越多越好。因为有些代码的是简单明了的,当你给这些代码也添加了注释,不会增强代码的可读性,反而会使得读代码的人找不到重点。所以,注释应该在有必要的地方出现。

5、当你发现你的某个注释很难说清楚相应代码的功能时,你就应该检查一下你的代码,可以考虑是不是要适当的使用更简单明了的代码替换它,并不是逻辑复杂的代码就好,大家都懂的代码,才是好代码。

以上就是本人暂时对注释的体会。