工程能力代码检查code Review

Posted 2022-12-14 HT . WANG

代码检查规则：

• 源文件规范

1. 文件名 ：java源文件名必须与包含的顶层类名一致
2. 文件编码：utf-8格式
3. 特殊字符：换行 缩进  空格

• 源文件组织规范

1. 许可证或版权声明：
2. package语句：单独占一行
3. import语句：单独占一行
4. 唯一的顶层类：每个源文件只允许包含唯一的顶层类

• 代码结构规范
• 命名规范
• OOP规约

1. 所有的POJO类属性必须使用包装数据类型 禁止基本数据类型
2. 所有覆写方法，加@Override注解
3. object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals
4. 定义DO/DTO/VO等POJO类是均不设定任何属性默认值

• 集合处理规范
• 控制语句规范
• 注释规约
• 异常处理规范
• 缺陷检查规则

CodeReview时一流代码特性：

1. 代码的正确和性能
2. 代码的可读和可维护性
3. 代码的可运维和可运营
4. 代码的可共享和可重用

CodeReview步骤：

• 先看系统全貌
• 进入模块级别

1. 判断模块切分是否合理
2. 理清模块内逻辑
3. 明确关键数据（关键的类和函数）  

• 理清类，函数内部逻辑
• 进入细节

如何做好CodeReview措施（公司层）

• 建立高效可运营的代码审核机制
• 通过工程能力地图考察代码code review情况
• 提高良好的工具和平台（推荐icode平台）