1最好的方式是使用eclipse中自带的重构Refactor功能
2整洁清楚的代码比注释要好得多
必要的注释:
1文件注释
使用模版功能:eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates
2类型(类,接口,枚举等)
通过javadoc的功能来看这段注释
3方法注释
这类注释也能自动生成在javadoc中,形成完整的文档格式
4变量注释
成员变量:功能、取值范围、存取时注意事项
局部变量:通常需要对主要变量做注释,无特别意义的变量无需加注释
5块注释
----------------------
(1)代码注释
虽然通过注释很容易看出这里的查询条件,但完全可以通过清晰的函数来“注释”这个意图:
(2)进一步说明
(3)
(4)
(5)
(6)
括号后面的注释
(7)在删除代码的同时也要删除相关的注释,实现代码和注释synchronized