静态测试方法之代码审查(CodeReview)的清单_codereview,codereview模板资源-CSDN文库

178 浏览量 2021-03-23 14:32:53 上传评论收藏 70KB PDF 举报

资源推荐

资源详情

资源评论

静态测试方法之代码审查静态测试方法之代码审查(Code Review)的清单的清单

静态测试方法之代码审查(Code Review)的清单。代码审查可以帮助提高代码质量，避免由于代码习惯而造成的 bug。下面列

出的这些要点因该可以作为大部分代码审查的指导，如果是 Java 应用的话，这些建议应该被视作最佳实践。

　　代码审查可以帮助提高代码质量，避免由于代码习惯而造成的 bug。下面列出的这些要点因该可以作为大部分代码审查的

指导，如果是 Java 应用的话，这些建议应该被视作最佳实践。

　　文档

　　1. Javadoc 应该在每一个类和方法中添加。

　　2. 如果是修复某个 bug，应该添加 bug ID。

　　3. 走捷径的方法或者复杂的逻辑要有解释。

　　4. 如果代码会被公开，每个文件头都要标注版权信息。

　　5. 复杂的 HTML，JavaScript，CSS 应该包含文档。

　　功能

　　1. 如果类似的逻辑被使用了多次，应该把它写成一个帮助类，然后在多出调用。

　　2. 鼓励使用 API 而不是重复编写代码解决相同的问题。

　　3. 要强调代码的单元测试。

　　4. 任何新加的代码不应该破坏已有的代码。

　　5. 假如是 Web 应用，JSP 不应该包含 Java 代码。

　　安全

　　1. 任何代码都不能执行用户的输入，除非转义过了。这个常常包含 JavaScript 的 eval 函数和 SQL 语句。

　　2. 禁止那些在短时间内提交非常多请求的 IP。

　　3. 任何类，变量，还有方法都应该有正确的访问域。

　　4. 尽量避免使用 iframe。

　　性能

　　1. 所有数据库和文件操句柄在不需要的时候都应该被关闭。

　　2. SQL 语句的写法会导致性能千差万别。

　　3. 鼓励创建不可变(immutable)的类。

　　4. 类似的逻辑代码，尽量通过 if else 语句来实现更多的重用。

　　5. 尽量避免使用重对象(heavy objects)。

　　6. 如果是 Web 项目，请检查是否使用了合适的图片尺寸，CSS sprites 和浏览器缓存等技术。

　　7. 全局都需要的信息保存在 application context 中。

本内容试读结束，登录后可阅读更多

下载后可阅读完整内容，剩余1页未读，立即下载

内容反馈

weixin_38697979

粉丝: 6
资源: 947

最新资源

资源上传下载、课程学习等过程中有任何疑问或建议，欢迎提出宝贵意见哦~我们会及时处理！点击此处反馈

feedback-tip