tangweijie
a437dde89f
- 新增 CLAUDE.md 文件，提供项目概述、技术栈、命令和架构信息 - 新增多个代码审查和文档生成专家的配置文件，包括 backend-reviewer、frontend-reviewer、database-expert、api-documenter、test-generator 和 refactor-expert - 新增 QUICK-REFERENCE.md 文件，提供快速参考和使用指南 - 新增 agents 目录下的 README.md 文件，详细说明各个 agent 的用途和使用方法 这些更改旨在提升开发效率和代码质量，提供清晰的指导和工具支持。
Claude Code Agents 使用指南
本项目包含 6 个专业的 Claude Code Subagents，用于提升开发效率和代码质量。
📋 可用的 Agents
1. 🔍 Backend Reviewer（后端代码审查专家）
文件: backend-reviewer.md
用途: 审查 Java/Spring Boot 后端代码
适用场景:
- 代码提交前的质量检查
- 识别安全漏洞和性能问题
- 验证 Spring Boot 最佳实践
- 审查数据库查询效率
使用方法:
@backend-reviewer 请审查这个 Service 类的代码质量
2. 🎨 Frontend Reviewer（前端代码审查专家）
文件: frontend-reviewer.md
用途: 审查 Vue.js 前端代码
适用场景:
- 审查组件设计和代码质量
- 检查 TypeScript 类型使用
- 识别性能优化机会
- 验证用户体验设计
使用方法:
@frontend-reviewer 请审查这个 Vue 组件的性能
3. 🗄️ Database Expert（数据库专家）
文件: database-expert.md
用途: 数据库设计和 SQL 优化
适用场景:
- 设计数据库表结构
- 优化复杂 SQL 查询
- 设计索引策略
- 编写数据迁移脚本
使用方法:
@database-expert 帮我优化这个 SQL 查询的性能
注意: 已配置项目数据库连接信息（192.168.10.126:3306/bank_go）
4. 📖 API Documenter（API 文档专家）
文件: api-documenter.md
用途: 生成和维护 API 文档
适用场景:
- 根据 Controller 生成 API 文档
- 编写接口使用示例
- 维护 API 变更记录
- 生成 Postman 集合
使用方法:
@api-documenter 为这个 Controller 生成完整的 API 文档
5. 🧪 Test Generator（测试代码生成专家）
文件: test-generator.md
用途: 生成单元测试和集成测试
适用场景:
- 为 Service 生成单元测试
- 为 Controller 生成集成测试
- 为 Vue 组件生成测试
- 提高代码覆盖率
使用方法:
@test-generator 为这个 Service 类生成完整的单元测试
6. ♻️ Refactor Expert（代码重构专家）
文件: refactor-expert.md
用途: 识别代码问题并提供重构方案
适用场景:
- 识别代码异味
- 简化复杂逻辑
- 应用设计模式
- 改善代码可维护性
使用方法:
@refactor-expert 请分析这段代码并提供重构建议
🚀 快速开始
在 Claude Code 中使用
-
列出所有 agents:
/agents -
调用特定 agent:
@agent-name 你的任务描述 -
查看 agent 详情: 在
/agents命令中选择对应的 agent 查看完整配置
组合使用示例
场景 1: 开发新功能
1. @database-expert 设计用户评分表结构
2. @backend-reviewer 审查生成的 Service 代码
3. @test-generator 生成单元测试
4. @api-documenter 生成 API 文档
场景 2: 代码优化
1. @refactor-expert 分析代码问题
2. @backend-reviewer 审查重构后的代码
3. @test-generator 补充测试覆盖
场景 3: 性能优化
1. @database-expert 分析慢查询
2. @backend-reviewer 检查代码性能问题
3. @frontend-reviewer 检查前端性能瓶颈
⚙️ 自定义配置
每个 agent 的配置文件都可以根据项目需求进行调整：
修改工具权限
tools: Read, Grep, Glob, Write, Bash
可用工具：
Read- 读取文件Grep- 搜索文本Glob- 文件模式匹配Write- 写入文件Bash- 执行命令
修改模型
model: sonnet # 或 opus（更强但更慢）
自定义系统提示
修改 YAML 元数据后的内容，添加项目特定的规则和约定。
📌 最佳实践
- 明确任务: 给 agent 提供清晰具体的任务描述
- 提供上下文: 说明相关的文件路径和代码位置
- 迭代改进: 根据 agent 的反馈逐步优化
- 版本控制: 将
.claude/agents/纳入 Git 版本管理 - 团队协作: 团队成员共享和改进 agent 配置
🔧 故障排除
Agent 无法找到
- 确保文件在
.claude/agents/目录下 - 检查文件名和
name字段是否一致 - 重启 Claude Code
Agent 权限不足
- 检查
tools配置是否包含所需工具 - 确认文件路径可访问
Agent 响应不符合预期
- 调整系统提示，提供更具体的指令
- 添加示例和约束条件
- 考虑使用更强大的模型（opus）
📚 相关资源
🤝 贡献
欢迎根据项目需求改进这些 agents：
- Fork 配置文件
- 添加新的 agent 或改进现有的
- 提交 Pull Request
- 分享最佳实践
📝 更新日志
v1.0.0 (2026-01-13)
- ✨ 初始版本
- ✅ 创建 6 个专业 agents
- 📖 完整的使用文档
提示: 这些 agents 会随着项目发展不断改进，建议定期review和更新配置。