xlcp/.claude/agents/QUICK-REFERENCE.md
tangweijie a437dde89f feat: 添加 Claude 代码助手和相关文档
- 新增 CLAUDE.md 文件,提供项目概述、技术栈、命令和架构信息
- 新增多个代码审查和文档生成专家的配置文件,包括 backend-reviewer、frontend-reviewer、database-expert、api-documenter、test-generator 和 refactor-expert
- 新增 QUICK-REFERENCE.md 文件,提供快速参考和使用指南
- 新增 agents 目录下的 README.md 文件,详细说明各个 agent 的用途和使用方法

这些更改旨在提升开发效率和代码质量,提供清晰的指导和工具支持。
2026-01-13 18:38:20 +08:00

5.5 KiB
Raw Blame History

🚀 Agents 快速参考卡

一句话调用

# 后端代码审查
@backend-reviewer 审查这个类的代码质量和性能

# 前端代码审查
@frontend-reviewer 检查这个组件的性能和用户体验

# 数据库优化
@database-expert 优化这个SQL查询并设计合适的索引

# 生成API文档
@api-documenter 为这个Controller生成完整文档

# 生成测试代码
@test-generator 为这个Service生成单元测试

# 代码重构
@refactor-expert 分析代码问题并提供重构方案

📋 常见任务速查

开发新功能流程

1⃣ @database-expert 设计数据表
   "帮我设计用户评分表包含用户ID、分数、评分时间等字段"

2⃣ 开发后端代码
   
3⃣ @backend-reviewer 审查代码
   "审查 ScoreService 的代码质量"
   
4⃣ @test-generator 生成测试
   "为 ScoreService 生成完整的单元测试"
   
5⃣ @api-documenter 生成文档
   "为 ScoreController 生成API文档"
   
6⃣ 开发前端页面
   
7⃣ @frontend-reviewer 审查前端
   "审查 ScoreList.vue 组件"

性能优化流程

1⃣ @database-expert 分析慢查询
   "这个查询很慢,帮我分析并优化"
   
2⃣ @backend-reviewer 检查后端性能
   "检查这个Service是否有性能问题"
   
3⃣ @frontend-reviewer 检查前端性能
   "这个页面加载慢,帮我找出原因"

代码质量提升流程

1⃣ @refactor-expert 识别问题
   "分析这段代码有什么问题"
   
2⃣ @refactor-expert 提供方案
   "提供详细的重构方案"
   
3⃣ 实施重构
   
4⃣ @backend-reviewer 验证重构
   "审查重构后的代码"
   
5⃣ @test-generator 补充测试
   "为重构后的代码生成测试"

💡 使用技巧

好的提问方式

❌ "看看这个代码"
✅ "@backend-reviewer 审查 UserService.java 的性能问题,特别关注数据库查询"

❌ "写个测试"
✅ "@test-generator 为 ScoreService.createScore() 方法生成单元测试,包含正常和异常场景"

❌ "优化数据库"
✅ "@database-expert 这个查询执行很慢贴上EXPLAIN结果帮我优化并设计合适的索引"

📍 提供清晰的上下文

  1. 指定文件路径

    @backend-reviewer 审查 backend/yudao-module-prison/src/main/java/cn/iocoder/yudao/module/prison/service/ScoreService.java
    
  2. 说明具体问题

    @database-expert 这个查询在数据量大时很慢经常超过5秒帮我优化
    
  3. 提供相关代码

    @refactor-expert 这个方法有100多行很难维护请帮我重构
    [贴上代码]
    

🎯 专项任务模板

新建数据表

@database-expert 
需求:设计一个问卷调查表
字段要求:
- 问卷ID主键
- 问卷标题
- 问卷描述
- 状态(草稿/已发布/已关闭)
- 创建人、创建时间、更新时间
- 需要关联到监区表

请设计完整的建表SQL包括索引和注释

代码审查检查清单

@backend-reviewer 
请审查以下方面:
1. 代码规范和可读性
2. 安全性SQL注入、权限控制
3. 性能问题N+1查询、缓存使用
4. 异常处理
5. 日志记录

[贴上代码]

生成完整测试

@test-generator 
请为 QuestionnaireService 生成完整测试:
1. 测试创建问卷(正常、重复、参数校验)
2. 测试查询问卷(分页、条件查询)
3. 测试更新问卷(状态流转、并发)
4. 测试删除问卷(软删除、权限)

使用 JUnit 5 和 Mockito

API文档生成

@api-documenter 
为 QuestionnaireController 生成API文档包括
1. 所有接口的请求参数和响应格式
2. 实际的cURL调用示例
3. 常见错误码说明
4. 接口调用流程图

使用Markdown格式

🔄 组合使用案例

Case 1: 接手遗留代码

# 第一步:理解代码结构
@refactor-expert "分析这个Service的职责和代码问题"

# 第二步:识别改进点
@backend-reviewer "列出这个类的主要问题"

# 第三步:补充测试
@test-generator "先生成测试保护现有功能"

# 第四步:逐步重构
@refactor-expert "提供分步骤的重构方案"

Case 2: 性能调优

# 第一步:数据库层面
@database-expert "分析这些慢查询日志并优化"

# 第二步:后端层面
@backend-reviewer "检查缓存使用和查询方式"

# 第三步:前端层面
@frontend-reviewer "检查是否有不必要的渲染和请求"

Case 3: 新功能开发

# 设计阶段
@database-expert "设计数据模型"

# 开发阶段
# (自己开发)

# 审查阶段
@backend-reviewer "审查后端实现"
@frontend-reviewer "审查前端实现"

# 质量保证
@test-generator "生成测试代码"
@api-documenter "生成接口文档"

快捷命令

# 列出所有agents
/agents

# 查看某个agent的详细配置
@backend-reviewer /help

# 切换到不同的agent
@frontend-reviewer

🎓 学习建议

  1. 从简单任务开始: 先用agents做代码审查熟悉它们的风格
  2. 逐步尝试复杂任务: 尝试让agents生成代码和测试
  3. 调整优化: 根据反馈改进你的提问方式
  4. 形成习惯: 将agents集成到日常开发流程中

📞 获取帮助

  • 查看完整文档:README.md
  • 查看agent配置.claude/agents/*.md
  • 实验和探索agents很智能大胆尝试

记住: Agents 是你的AI编程助手充分利用它们提升开发效率 🚀