代码评审的18条军规

刀刀

3/20/2025

0 字

0 分钟

添加必要注释

好的方法名、变量名即是最好的注释，不需要写太多注释：

所有类都添加创建者、创建日期，以及简单的注释描述
方法内部复杂业务逻辑或算法，需要添加清楚的注释
一般情况，注释描述类、方法、变量的作用
任何需要提醒的警告或TODO，也要注释清楚
注释一行代码用 // ，注释代码块或接口方法用 /* */
一块代码逻辑如果在陌生人角度看第一遍看不懂，就添加注释

日志打印规范

日志能快速定位问题

日志级别选择不对，常见日志有 error、warn、info、debug 四种
包含关键信息需要脱敏处理

命名规范

命名应清晰简洁易懂

类名、接口名首字母要大写的驼峰命名
方法名、变量名首字母小写的驼峰命名
常量应全大写字母
选择易懂的名称给变量、方法、类命名

参数校验与盘空处理

注意参数是否有做校验，如表单参数是否有非空校验，页面用户信息是否有空判断处理，获取数组对象内容是否要添加可选链避免空错误等。

程序主次是否清晰，主次是否分明

方法要解耦，不要把全部的方法都写到一个函数方法内