任何一个傻瓜都能写出计算机可以理解的程序，只有写出人类容易理解的程序才是优秀的程序员。
—— Martin Flower 《重构》
写在前面的话
总是去做
- 经常REVIEW自己3个月、6个月以前的代码，多对自己的代码做总结
- 代码是写给人看的，所以尽可能使用简单的方法
- 遵守常理（公共约定），不要使用让人误解和有背常理的描述，写的代码应当让普通人易于理解
- 保持代码和注释描述的是同一件事情，如果无法做到就把注释删除吧
- 总是使用
checkstyle
或findbugs等工具，并努力消除这类工具报告的问题
评价代码好坏
代码风格
- 源文件尽可能使用
UTF-8编码保存 - 代码缩进使用2个或4个
" "(\x20 即 空格)，而不是使用TAB - 整修工程使用一致的代码风格，不管有多少人参与开发
命名
异常处理
- 禁止任何形式的"吃"异常
日志处理
线程安全
其它
思考问题
如何尽可能保证代码没有BUG?
- 尽可能测试到所有分支
- 尽在模拟真实的场景测试
- 学习并总结自己和别人遇到过的问题
- 尽可能了解你写的每行代码将会如何运行
如何尽早发现BUG?
- 尽早做单元测试
- 尽可能做接口测试
- 尽可能做自动化回归测试
- 架构设计上尽可能把约束提前
如果在BUG发生后早快定位问题?
- 不要吃掉任何异常
- 在错误日志中尽可能打印详细的上下文信息
- 如果使用log4j等日志工具，可以使用
MDC设置环境信息 - 在写代码的时候多考虑一下如果这里有问题需要哪些信息我能够快速定位问题
推荐书籍
| 编写可读代码的艺术 | http://book.douban.com/subject/10797189/ |
|---|---|
| 代码大全（第2版） | http://book.douban.com/subject/1477390/ |
| 重构 | http://book.douban.com/subject/1229923/ |
| Java并发编程实战 | http://book.douban.com/subject/10484692/ |