code-quality-review

代码质量审查

概述

从多个维度系统地分析代码质量，包括可维护性、可读性、复杂度、设计模式、命名规范、代码重复以及对最佳实践的遵循情况。提供带严重性评级和具体改进建议的可执行反馈。

核心能力

1. 代码异味检测 - 识别臃肿代码、面向对象滥用、变更阻碍、冗余代码和耦合问题
2. 复杂度分析 - 衡量圈复杂度和认知复杂度，并评估风险
3. 可维护性评估 - 评估代码可维护性指数和技术债务
4. 设计模式评估 - 审查架构模式和 SOLID 原则
5. 最佳实践验证 - 检查是否遵循特定语言的标准和约定

审查工作流

步骤 1：评估范围

根据变更规模确定审查范围：

• 小型（<100 行）：快速正确性检查，15-30 分钟
• 中型（100-500 行）：全面质量分析，1-2 小时
• 大型（>500 行）：架构审查；如有可能，拆分为更小的审查，2-4 小时

有关特定范围的指导，请参阅 review-scope-guidelines.md

步骤 2：初步评估

收集背景信息：

• 确认编程语言和框架
• 了解项目类型（Web 应用、API、库、CLI 等）
• 记录现有的编码标准或风格指南
• 检查代码检查器配置文件（.eslintrc、.pylintrc、checkstyle.xml 等）

阅读代码：

• 从入口点（主文件、索引文件）开始
• 查看模块/包的组织结构
• 检查依赖管理
• 查看测试文件（如有）

步骤 3：质量分析

从以下关键维度分析代码：

• 代码异味：过长的方法、过大的类、重复代码、死代码等
• 复杂度：圈复杂度（目标 <15）、认知复杂度、嵌套深度
• 可维护性：命名清晰、抽象恰当、关注点分离
• 设计模式：模式使用是否恰当、是否遵循 SOLID 原则
• 最佳实践：语言惯用写法、错误处理、资源管理

有关详细的分析标准和阈值，请参阅 review-workflow.md

有关质量指标和阈值，请参阅 quality-metrics-reference.md

步骤 4：记录发现

按以下结构编写审查报告：

• 包含评分和首要事项的执行摘要
• 详细发现，包括严重性、位置、描述和建议
• 指标摘要，包括当前值与目标值
• 按优先级排序的建议（P0-P3）
• 肯定良好实践的正面观察
• 技术债务摘要及工作量估算

有关完整的报告结构和输出指南，请参阅 review-report-format.md

质量保证

使用清单确保审查全面：

• 代码组织和结构
• 命名约定和清晰度
• 复杂度阈值
• 错误处理模式
• 测试和文档
• 安全考量
• 性能影响

有关完整清单，请参阅 best-practices-checklist.md

常见误区

避免以下常见的审查错误：

• 只关注风格问题，而忽略实质性问题
• 过度批评，却不给出可执行的建议
• 忽视背景和业务约束
• 一次提出过多问题，让人难以应对
• 使用含糊的说法，却不加以解释
• 忘记肯定良好实践

有关详细指导，请参阅 common-pitfalls-to-avoid.md

示例模式

审查时识别关键问题，可参考 critical-issues.md 中常见高严重性问题的示例