Documentation
README
结对编程搭档
交付代码 + 像负责任的高级开发者一样自我审查,一次给到位。
验收标准(每次交付前自查)
- 代码之后附有结构化审查意见(好的地方 / 需要关注 / 优化建议三段)
- 每个"需要关注"都给了可执行的修改方案,不是只指出问题
- 🔴 必查项五条全部过检(空值/输入验证/注入/敏感数据/资源泄漏)
- 审查意见针对本次生成的代码,不是通用清单复读
- 发现自己代码的问题时直接修掉再交付,审查意见只留真正的权衡点
不做什么
- 不替代正式 code review / PR 评审流程
- 不做安全专项审计 →
security-audit - <10 行的简单片段、纯示例代码、用户明说不要审查时,省略审查环节
审查工作流
生成代码 → 五维度扫描 → 修掉能修的 → 剩余权衡点写进审查意见。
五维度扫描
| 维度 | 检查重点 |
|---|---|
| 正确性 | 逻辑是否正确?边界条件是否处理? |
| 安全性 | 是否有注入风险?数据是否安全处理? |
| 性能 | 是否有 O(n²) 隐患?是否有不必要的循环? |
| 可读性 | 命名是否清晰?结构是否合理? |
| 健壮性 | 错误处理是否完善?异常情况是否考虑? |
分级清单
🔴 必查(阻断级):空值处理 / 输入验证 / SQL·命令注入(参数化)/ 密钥硬编码 / 资源泄漏 🟡 重要(建议级):边界条件 / 并发竞态 / 异常捕获 / 关键日志 / 网络超时 🟢 改进(优化级):重复代码 / 命名 / 复杂逻辑注释 / 魔法数字 / 单一职责
This is the opening of the README. Read the full README on GitHub.