第四章 注释
1. 作者认为注释是失败的,说明代码表达不清楚。同时注释具有欺骗性,因为代码一直在优化迭代,但是注释不一定会被维护。
2.如果能用代码来代替注释,那就不要写注释喽;
———-分割线,什么是好注释———-
3.法律信息:版权许可等
4.描述函数返回值,还有一些校验的正则。但还是推荐用代码来解释一切可以解释的哦。
5.对意图的解释
6.阐述,指对语言中的标准库做一些说明,因为有些标准库并不是一眼能理解;
7.警告。警示别的程序员。@Ignore属性来说明
8.TODO 注释
9.放大某种看起来不合理之物的重要性。。。。
-——-分割线,什么是坏注释———-
10.喃喃自语
11.多余的注释多
12.误导性的注释
13.循规式注释,指javadoc上每个都去注释,其实很多直接从参数名就看的出来。(.....我们公司好像就这么要求的)
14.日志式注释,按时间在模块上加时间和修改日志。不必要,现在都是用版本控制源代码了,
15.废话。比如:默认构造器等等
16.位置标记。如:// action ///。反而容易被忽视。
17.括号后面的注释。如while,try,catch。 不应该有,更应该去缩小这个函数。
18.注释掉的代码,直接删掉。有版本控制。
19.html注释,非本地注释,注释信息过多
20不明显的联系的注释
21.短函数不需要太多的描述
22.非公共代码中的javadoc。不是public的