代码评审 checklist:提升代码质量的检查项

代码评审checklist:确保代码质量

代码结构检查

变量和函数命名是否清晰、符合约定(如驼峰命名法)。
代码模块化程度是否足够,避免过长函数或类(建议函数不超过50行)。
重复代码是否已提取为公共函数或工具类。

可读性与风格

代码缩进、空格是否一致(遵循项目规范如2/4空格)。
注释是否清晰,避免冗余(注释应解释“为什么”而非“做什么”)。
魔法数字是否替换为常量或枚举。

功能逻辑验证

边界条件是否处理(如空值、负数、最大值)。
错误处理是否完备(异常捕获、日志记录、用户提示)。
多线程或异步操作是否考虑竞态条件和资源释放。

性能与安全

是否存在内存泄漏风险(如未关闭的流、缓存滥用)。
数据库查询是否优化(避免N+1查询、索引使用)。
敏感数据是否加密(密码、密钥),输入是否校验(防SQL注入/XSS)。

测试覆盖

单元测试是否覆盖核心逻辑(覆盖率≥80%)。
测试用例是否包含边界场景和异常流程。
Mock数据是否真实反映生产环境。

提交与文档

Git提交信息是否清晰(如“fix: 登录页按钮样式错误”)。
依赖变更是否更新文档(如README或CHANGELOG)。
新接口或配置是否补充Swagger或注释说明。

提示:可结合自动化工具(如SonarQube、ESLint)辅助检查基础项。

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值