Code Review 技能使用说明

技能概述

这是一个专业的代码审查技能，用于在代码提交前进行全面的质量检查。

主要特性

✅ 通用性强 - 适用于任何包含 CLAUDE.md 的项目
✅ 自动化 - 自动读取项目规范进行审查
✅ 全面检查 - 涵盖架构、类型、数据库、测试、安全等多个维度
✅ 中文支持 - 完全中文化的文档和报告
✅ UTF-8 编码 - 所有文件使用 UTF-8 编码

安装方法

将 code-review.skill 文件放入 Claude Code 的 skills 目录：

C:\Users\<你的用户名>\.claude\skills\

触发场景

此技能会在以下场景自动触发：

1. 用户明确请求进行代码审查
2. git commit 前的代码检查
3. 创建 Pull Request 前的审查
4. 代码合并前的质量把关

使用方法

基本使用

直接对 Claude 说：

请对我的代码进行 review

或

帮我审查一下待提交的代码

工作流程

技能会自动执行以下步骤：

1. 读取项目规范 - 读取项目根目录的 CLAUDE.md 文件
2. 识别待审查代码 - 使用 git 命令确定代码范围
3. 执行多维度审查 - 根据项目规范进行全面检查
4. 生成审查报告 - 输出结构化的审查结果

检查维度

1. 架构合规性检查

• Service 层不直接访问数据库
• Service 层不直接发送 HTTP 请求
• 正确的分层架构

2. 类型安全检查

• PHP 类型声明完整性
• 空值处理正确性

3. 数据库相关检查

• SQL 查询字段索引检查
• 索引失效场景检查
• 索引依赖注释

4. 测试覆盖率检查

• 单元测试存在性
• 测试覆盖率（目标 100%）

5. 代码质量检查

• 数组合并方法（ArrayHelper::merge）
• 代码复杂度
• 命名规范

6. 安全性检查

• SQL 注入风险
• XSS 攻击风险
• 敏感信息泄露

7. 性能检查

• N+1 查询问题
• 大数据量处理

8. 文档维护检查

• CLAUDE.md 更新
• 代码注释完整性

审查报告格式

审查报告包含以下部分：

# 代码审查报告

## 📊 概览
- 审查文件数、发现问题数、严重程度分布

## 📁 文件审查详情
- 每个文件的通过检查和发现的问题

## 🎯 总体评估
- 代码质量综合评价

## ✅ 审查结论
- 是否可以提交
- 必须修复的问题清单

严重程度分级

• 🔴 严重 - 必须修复才能提交
• 🟡 警告 - 强烈建议修复
• 🟢 建议 - 可选的改进

文件结构

code-review/
├── SKILL.md                      # 技能主文档
├── scripts/                      # 辅助脚本
│   ├── get_review_files.py       # 获取待审查文件的脚本
│   └── parse_claude_md.py        # 解析 CLAUDE.md 的脚本
└── references/                   # 参考文档
    └── checklist.md              # 详细检查清单

辅助脚本说明

get_review_files.py

获取待审查的文件列表和差异信息。

# 获取所有变更（暂存 + 未暂存）
python scripts/get_review_files.py

# 只获取已暂存的文件
python scripts/get_review_files.py --staged

# 获取指定提交的文件
python scripts/get_review_files.py --commit HEAD

# JSON 格式输出
python scripts/get_review_files.py --json

parse_claude_md.py

解析项目的 CLAUDE.md 文件，提取关键规范信息。

# 解析当前目录的 CLAUDE.md
python scripts/parse_claude_md.py

# 解析指定路径的 CLAUDE.md
python scripts/parse_claude_md.py /path/to/CLAUDE.md

# JSON 格式输出
python scripts/parse_claude_md.py --json

提取信息包括：
- 项目名称和主要语言
- 使用的框架
- 架构规则（如分层架构）
- 编码规范（如类型声明）
- 数据库规则（如索引要求）
- 测试要求（如覆盖率）
- 第三方集成

注意： 这些脚本是可选的辅助工具，Claude 可以直接读取和理解 CLAUDE.md 文件。

注意事项

1. 依赖 CLAUDE.md - 此技能依赖项目的 CLAUDE.md 文件，如果项目没有此文件，将使用通用最佳实践
2. 数据库检查 - 如果项目配置了 MySQL MCP 服务器，会自动使用相关工具检查索引
3. UTF-8 编码 - 所有文件使用 UTF-8 编码，确保中文正常显示

技能信息

• 名称: code-review
• 版本: 1.0.0
• 编码: UTF-8
• 语言: 中文
• 创建日期: 2026-01-20

许可

本技能基于项目 CLAUDE.md 规范创建，用于提升代码质量。