代码评审报告

代码评审报告

项目名称

XXX

模块名称

XXX

开发者

XXX

评审日期

评审结果

评审人

代码地址

XXX分支

XXX版本号

check list

是

否，指出问题所在或者解释原因

总体

代码风格应满足公司代码规范

所有业务设计应已经完整实现

代码不应有逻辑缺陷

代码的命名应清晰、明了

不应实现一个现在不用而未来可能需要的功能

注释 

注释应清楚且有用

注释应是最新的

代码异常处理时应有注释

安全

代码应合理控制线程安全

代码不应有SQL注入风险

代码不应有脚本注入风险

代码应符合完整的事务处理

代码应防止过度的资源损耗，如短信等资源

IO流操作时要及时释放资源

功能不应有越权风险

代码不应有内存泄漏风险

代码不应出现NPE问题

性能

不要使用过时、陈旧或低效的方法

代码不应该复杂超过原本所必须的

循环嵌套应优化到最少

应合理使用缓存机制

SQL应经过调优，合理使用索引

任务有主次之分的，应合理使用异步线程池

健壮性

请求传入的任何参数必须做有效性验证

状态流转时，应有前置状态判断

代码应有完善的异常处理

代码应有完善的日志记录入参等信息