用途:提供系统化的代码审查方法,帮助在代码库中保持一致的代码质量标准,适用于审查拉取请求、结对编程、制定团队审查标准、提交前自审以及指导初级开发者。
主要能力:按十个类别组织检查项——功能与正确性、设计与架构、可读性与可维护性、测试、安全、性能、文档、依赖与库、错误处理与日志、代码风格与一致性。每个类别给出具体检查点、需提出的问题、反模式示例(如上帝类、深层嵌套、重复代码、循环内同步 I/O、N+1 查询)以及命名、注释、结构化日志等正反示例。安全部分参考 OWASP Top 10 考虑项。
使用方式:审查前理解上下文、阅读 PR 描述与关联议题、预留充足时间、检查 CI/CD 是否通过;审查中使用 Nitpick、Question、Suggestion、Issue 等标签,聚焦功能与安全,避免在风格上纠缠;反馈应建设性,先肯定优点,以建议而非命令方式提出,并解释理由。还给出审查规模建议(小于 200 行理想,200–500 行可接受,超过 500 行建议拆分)、自审清单、批准标准与要求修改的情形。
适用场景:团队代码评审流程、个人提交前自检、建立团队审查规范、与代码质量智能体配合使用。
限制:资料未提供具体安装命令、平台支持、收费或价格信息;检查项中的覆盖率阈值(如通常 >80%)与性能基准等为示例性建议,需按团队实际情况调整;团队特定检查(技术栈规则、业务逻辑、GDPR/HIPAA/SOX 等合规要求)需自行定制。