用途
Code Reviewer 是一个用于软件质量保证的综合代码审查与分析技能。当 Claude 需要审查任意格式的代码(包括单个文件等)时使用,可将 Claude 转变为系统化的代码审查者,从质量、可维护性和最佳实践等多个维度评估软件项目。
主要能力
该技能提供了一套结构化的审查框架,涵盖以下维度:
-
项目结构评估:分析目录结构、文件命名、项目布局、配置文件(如 setup.py、requirements.txt、.gitignore)以及入口点。
-
文档审查:评估模块 docstring、README 文件、内联注释、API 文档、docstring 格式、类型提示、示例用法和变更文档(CHANGELOG、版本历史)。
-
逻辑与缺陷检测:系统分析常见缺陷模式(空值/None 处理、索引错误、类型不匹配、逻辑错误、资源泄漏)、算法正确性、边界情况、错误处理和性能考量。
-
测试评估:评估单元测试、集成测试、测试覆盖率、测试数据、测试组织,以及测试独立性、断言质量、mock 使用和参数化测试等最佳实践。
-
代码质量与一致性:审查格式一致性、命名约定、代码组织、导入组织,以及重复代码、过长函数/类、死代码、魔法数字、不一致模式等代码异味。
-
Jupyter Notebook 专项审查:包括单元格组织、叙述质量、可复现性、输出管理,以及数据加载、探索性分析、可视化质量和结果解读等数据科学最佳实践。
使用方式
该技能通过结构化的审查框架指导代码审查,并按照以下输出结构呈现结果:
- 执行摘要:总体评估、主要建议(前 3-5 项)、优势、风险等级。
- 详细分析:文档评估、逻辑与缺陷审查、测试分析、代码质量问题,每项包含组件/位置、当前状态、问题、建议和优先级。
- 改进路线图:按优先级排列的行动项(关键问题、高优先级、中优先级、低优先级)。
此外还提供语言特定考量(Python 的 PEP 8、虚拟环境、包结构、异常处理;R 的编码风格、包文档、Roxygen2、testthat;JavaScript/Node.js 的 ES6+、package.json、ESLint、异步处理)以及通用最佳实践(版本控制、配置管理、安全考量、性能)。
反馈指南强调建设性批评(具体、解释理由、提供替代方案、考虑上下文)、正面认可(肯定良好实践、注意改进、赞赏设计决策)和可操作建议(问题描述、具体代码变更、预期收益、实施工作量估计)。
审查流程清单包括:检查范围内所有文件、验证代码可运行/导入、审查测试文件、检查文档完整性、识别安全或性能问题、提供具体可操作的反馈、合理排列建议优先级、保持建设性和专业语气。
适用场景
适用于需要系统化代码审查的软件开发场景,包括审查单个文件、评估项目整体质量、检查文档和测试完备性、识别潜在缺陷和代码异味,以及审查 Jupyter Notebook 等。
限制
资料中未提供关于收费、价格、平台支持范围或具体效果保证的信息。