1700453308
编写高质量代码：改善Java程序的151个建议 建议146：让注释正确、清晰、简洁
1700453309
1700453310
从我们写第一个“Hello World”程序开始，就被谆谆教导“代码要有注释”，而且一加就是好多年，基本上是代码就有注释，而且有的还很多，甚至有的是长篇累牍的。我们先来看一些不好的注解习惯。
1700453311
1700453312
（1）废话式注释
1700453313
1700453314
比如这样的注释：
1700453315
1700453316
/*
1700453317
1700453318
*该算法不如某某算法优秀，可以优化，时间太紧，以后再说
1700453319
1700453320
*/
1700453321
1700453322
public void doSomethong（）{
1700453323
1700453324
}
1700453325
1700453326
想说明什么？只是表明这个算法需要优化？还是说这是未完成的任务？那可以用TODO标记呀，注释是给人看的，此类代码提交上去后，基本上不会再修改它了，除非它出现Bug，或者维护人员碰巧看到这个注释，然后选择了优化它—注释不是留给“撞大运”人员的。
1700453327
1700453328
（2）故事式注释
1700453329
1700453330
曾经检查过一段极品代码，注释写得非常全面，描述的是汉诺塔算法，从汉诺塔的故事（包括最原始的版本和多个变形版本）到算法分析，最后到算法比较和实际应用，写得那是栩栩如生，而且还不时加入了一些崭新的网络用语，幽默而又不失准确，可以这么说，看完这段注释基本上对汉诺塔的“前世今生”有了深刻的了解，但是我在检查后的改正意见是：把注释修改为“实现汉诺塔算法”即可。注释不是让你讲故事的地方，就这7个字，已经完全可以说明你的代码了！
1700453331
1700453332
我们的代码是给人看的，但不是给什么都不懂的外行看的，相信我们代码的阅读者一定是具有一定编码能力的，不是对代码过敏的“代码白痴”。
1700453333
1700453334
（3）不必要的注释
1700453335
1700453336
有些注释相对于代码来说完全没有必要，算不上是废话，只能说是多余的注解，看下面的例子。
1700453337
1700453338
class Foo{
1700453339
1700453340
//默认值为0
1700453341
1700453342
private int num；
1700453343
1700453344
//取值
1700453345
1700453346
public int getNum（）{
1700453347
1700453348
return num；
1700453349
1700453350
}
1700453351
1700453352
//输入int类型变量，无返回值
1700453353
1700453354
public void setNum（int num）{
1700453355
1700453356
this.num=num；
[
上一页 ]
[ :1.700453307e+09 ]
[
下一页 ]