摘要: 代码审查可以帮助提高代码质量,避免由于代码习惯而造成的 bug。下面列出的这些要点因该可以作为大部分代码审查的指导,如果是 Java 应用的话,这些建议应该被视作最佳实践。文档1. Javadoc 应该在每一个类和方法中添加。2. 如果是修复某个 bug,应该添加 bug ID。3. 走捷径的方法或者复杂的逻辑要有解释。4. 如果代码会被公开,每个文件头都要标注版权信息。5. 复杂的 HTML,JavaScript,CSS 应该包含文档。功能1. 如果类似的逻辑被使用了多次,应该把它写成一个帮助类,然后在多出调用。2. 鼓励使用 API 而不是重复编写代码解决相同的问题。3. 要强调代码的单元 阅读全文
posted @ 2012-08-10 21:39 Think in Java 阅读(136) 评论(0) 推荐(0) 编辑