项目代码Review总结

Code Review 意义:

• 交叉排查缺陷：通过团队成员相互审核，避免代码层面出现显而易见的问题
• 提高代码质量：通过团队成员相互监督，在完成功能的基础之上不断完善代码结构
• 建立团队意识：代码是团队财产，团队成员在相互督促与改进中共同成长

Code Review 体系

• 日常 Code Review：开发者完成初步结构设计，或者完成一个相对完整的小模块达到可提交阶段
• 需求 Code Review：评估需求完成度，与其它需求的潜在冲突
• 上线 Code Review：上线前Review，重点排查配置问题，安全问题，代码冲突
• 重点代码 Code Review：一定周期内对具有代表性的代码集体走读，重点在于解决团队共性问题，讨论改进方法

Code Review 重要指标

• 代码结构格式化清晰
• 变量、方法等命名符合规范
• 核心代码逻辑清晰且有必要注释说明
• 临时性代码增加主要标识（@FIXME）

组件全名使用驼峰或或者短横线

MyClass.vue
my_class.vue

注释规范

函数注释

/**
* 函数标题，解析
* @param 描述参数的信息
* @return 描述返回值的信息
* @author 作者 时间
* @version 版本号
* @example 实例
**/

编辑规范

— 使用类型严格的 ===。仅当判断 null 或 undefined 时，允许使用 == null。

// 建议
if(age === 20){
    
}
// 不推荐使用
if(age == 20){}

• 尽可能使用简洁的表达式

// 建议
if(!data){}

// 不推荐使用
if(data == ''){}

• 对于相同变量或表达式的多值条件，用 switch 代替 if。