multi-perspective-code-review
多角度代码审查技能
目录 / 开发工具 / code-review-guidelines
代码审查指南及检查清单 一、代码审查目标 - 确保代码质量、可维护性和一致性 - 发现潜在缺陷、安全漏洞和性能问题 - 促进团队知识共享与代码规范统一 - 提升团队协作效率与代码可读性 二、审查前准备 - [ ] 审查者已了解本次变更的背景和需求 - [ ] 代码已通过本地构建和基本测试 - [ ] 提交信息清晰,包含变更目的和相关任务链接 - [ ] 代码变更范围合理,避免一次性提交过多修改 三、代码审查检查清单 1. 功能正确性 - [ ] 代码是否实现了预期功能? - [ ] 是否存在逻辑错误或边界条件未处理? - [ ] 单元测试是否覆盖主要功能和异常场景? 2. 代码质量 - [ ] 命名是否清晰、一致(变量、函数、类等)? - [ ] 是否有重复代码?是否可复用或抽象? - [ ] 函数长度是否适中?是否遵循单一职责原则? - [ ] 注释是否必要且准确?避免过度注释或无意义注释 3. 可读性与结构 - [ ] 代码结构是否清晰,模块划分合理? - [ ] 缩进、空格、换行等是否符合团队编码规范? - [ ] 是否使用了合适的语言特性或设计模式? 4. 安全性 - [ ] 是否存在常见安全风险(如SQL注入、XSS、越权访问等)? - [ ] 敏感数据是否妥善处理(如加密、脱敏)? - [ ] 权限校验是否完整? 5. 性能与效率 - [ ] 是否存在不必要的循环、递归或资源消耗? - [ ] 数据库查询是否优化?是否避免N+1问题? - [ ] 是否合理使用缓存、异步处理等机制? 6. 测试覆盖 - [ ] 新增代码是否有对应测试? - [ ] 测试用例是否覆盖正常流程和异常情况? - [ ] 测试是否易于理解和维护? 7. 依赖与兼容性 - [ ] 是否引入了不必要的第三方依赖? - [ ] 依赖版本是否稳定且兼容现有系统? - [ ] 是否影响其他模块或服务? 8. 文档与日志 - [ ] 是否需要更新相关文档(如API文档、部署说明)? - [ ] 日志输出是否恰当(级别、内容、敏感信息)? 四、审查后处理 - [ ] 所有问题已记录并明确责任人 - [ ] 提出的问题具体、可操作,避免模糊反馈 - [ ] 鼓励建设性沟通,尊重开发者意图 - [ ] 审查通过后及时批准合并请求 五、最佳实践建议 - 每次审查聚焦少量变更(建议不超过400行代码) - 优先审查核心逻辑和高风险模块 - 使用工具辅助(如静态分析、自动化测试)提升效率 - 定期回顾审查流程,持续优化指南 通过遵循本指南,团队可提升代码质量,减少缺陷,并建立高效协作的审查文化。
| 版本 | 存档时间 | 内容哈希 | 内容 |
|---|---|---|---|
| v1 | 2026-11-09 22:05 | 3ad71b37 | 可取 |
版本索引永久保留;内容副本只保留最新 1 份,更早版本仅留索引与哈希(存档时间线的证据链不会因此断裂)。
多角度代码审查技能
定义iOS应用的SPM包结构、层依赖关系和设计原则
通过 cross-review-mcp 代理,在两个 Claude Code 实例之间开展结构化跨项目代码审查
将模糊或宏大的想法转化为一个恰到好处的、仅包含需求的统一计划
为当前工作树或拉取请求 URL 打开 Plannotator 的基于浏览器的代码审查界面,然后根据返回的反馈采取相应操作
根据仓库的 rules 对变更差异进行审查,仅检测带有严重程度的规则违反项
侵权举报经核验成立后,我们会即时下线该条目并删除已存的内容副本。