Update from Sync Service
This commit is contained in:
FNS Service
281
AI工程/ClaudeCode使用技巧与最佳实践.md
Executable file
281
AI工程/ClaudeCode使用技巧与最佳实践.md
Executable file
@@ -0,0 +1,281 @@
|
||||
# Claude Code 使用技巧与最佳实践
|
||||
|
||||
> 全面指南：从入门到精通
|
||||
>
|
||||
> 归档：2026-04-23
|
||||
|
||||
---
|
||||
|
||||
## 📊 核心资源
|
||||
|
||||
| 项目 | Stars | 用途 |
|
||||
|------|-------|------|
|
||||
| **claude-code-best-practice** | ⭐ 47,397 | 最佳实践百科 |
|
||||
| **ClaudeForge** | ⭐ 353 | CLAUDE.md 自动生成工具 |
|
||||
| **awesome-claude-md** | ⭐ 242 | 优秀 CLAUDE.md 集合 |
|
||||
| **claude-md-templates** | ⭐ 156 | CLAUDE.md 模板 |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 安装与配置
|
||||
|
||||
### 一键安装
|
||||
```bash
|
||||
curl -fsSL https://claude.ai/install.sh | bash
|
||||
```
|
||||
|
||||
### 快速验证
|
||||
```bash
|
||||
claude --version
|
||||
claude doctor
|
||||
```
|
||||
|
||||
### 选择模型
|
||||
```bash
|
||||
/model claude-sonnet-4-20260620
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 核心使用技巧
|
||||
|
||||
### 1. 编写优秀的 CLAUDE.md
|
||||
|
||||
**CLAUDE.md 是提升 Claude Code 效果的最重要因素！**
|
||||
|
||||
**结构建议**：
|
||||
```markdown
|
||||
# 项目名称
|
||||
|
||||
## 概述
|
||||
简短描述项目做什么。
|
||||
|
||||
## 技术栈
|
||||
- 语言/框架/工具
|
||||
|
||||
## 项目结构
|
||||
```
|
||||
src/
|
||||
├── components/
|
||||
├── utils/
|
||||
└── types/
|
||||
```
|
||||
|
||||
## 开发规范
|
||||
- 代码风格
|
||||
- 命名约定
|
||||
- 测试要求
|
||||
|
||||
## 常用命令
|
||||
- `npm run dev` - 开发服务器
|
||||
- `npm test` - 运行测试
|
||||
```
|
||||
|
||||
### 2. 使用 ClaudeForge 自动生成
|
||||
|
||||
```bash
|
||||
# 安装 ClaudeForge
|
||||
curl -fsSL https://raw.githubusercontent.com/alirezarezvani/ClaudeForge/main/install.sh | bash
|
||||
|
||||
# 重启 Claude Code 后运行
|
||||
/enhance-claude-md
|
||||
```
|
||||
|
||||
**功能**：
|
||||
- 自动扫描项目结构
|
||||
- 检测技术栈
|
||||
- 生成高质量 CLAUDE.md
|
||||
- 质量评分 (0-100)
|
||||
- 后台自动维护
|
||||
|
||||
### 3. 参考优秀案例
|
||||
|
||||
查看 [awesome-claude-md](https://josix.github.io/awesome-claude-md/) 获取真实项目的优秀示例。
|
||||
|
||||
---
|
||||
|
||||
## 🎯 高效工作流
|
||||
|
||||
### 日常开发
|
||||
|
||||
```bash
|
||||
# 1. 启动会话
|
||||
cd project && claude
|
||||
|
||||
# 2. 描述任务
|
||||
帮我实现用户认证功能，包括登录、注册和 JWT
|
||||
|
||||
# 3. 代码审查
|
||||
/review
|
||||
|
||||
# 4. 测试
|
||||
运行测试并修复失败的用例
|
||||
|
||||
# 5. 提交
|
||||
git add . && git commit -m "feat: 添加用户认证"
|
||||
```
|
||||
|
||||
### 大型重构
|
||||
|
||||
```bash
|
||||
# 使用 batch 命令
|
||||
/batch migrate src/ from JavaScript to TypeScript
|
||||
|
||||
# 自动分解任务 → 并行执行 → 创建 PR
|
||||
```
|
||||
|
||||
### 调试模式
|
||||
|
||||
```bash
|
||||
# 启用调试
|
||||
/debug
|
||||
|
||||
# 或者使用调试技能
|
||||
/debug 分析这个错误：TypeError: Cannot read property 'x' of undefined
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 关键命令速查
|
||||
|
||||
| 命令 | 用途 |
|
||||
|------|------|
|
||||
| `/compact` | 压缩上下文（节省 token） |
|
||||
| `/context` | 查看上下文使用 |
|
||||
| `/cost` | 查看费用统计 |
|
||||
| `/agents` | 管理子代理 |
|
||||
| `/batch` | 大规模并行修改 |
|
||||
| `/diff` | 查看变更 |
|
||||
| `/undo` | 撤销修改 |
|
||||
| `/copy` | 复制回复 |
|
||||
| `/model` | 切换模型 |
|
||||
| `/config` | 设置面板 |
|
||||
|
||||
---
|
||||
|
||||
## 🤖 子代理最佳实践
|
||||
|
||||
### 何时使用子代理？
|
||||
|
||||
| 场景 | 子代理类型 | 说明 |
|
||||
|------|-----------|------|
|
||||
| 代码探索 | `Explore` | 只读，快速搜索 |
|
||||
| 代码修改 | `general-purpose` | 读写，复杂任务 |
|
||||
| 代码审查 | 自定义 | 只读，反馈 |
|
||||
| 测试运行 | 自定义 | 隔离执行 |
|
||||
|
||||
### 创建自定义子代理
|
||||
|
||||
```markdown
|
||||
# .claude/agents/code-reviewer.md
|
||||
---
|
||||
name: code-reviewer
|
||||
description: 代码审查助手
|
||||
tools: Read, Grep, Glob
|
||||
model: sonnet
|
||||
---
|
||||
|
||||
你是一个高级代码审查员。审查代码时：
|
||||
1. 检查代码质量
|
||||
2. 指出安全隐患
|
||||
3. 建议性能优化
|
||||
4. 保持 constructive 反馈
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 CLAUDE.md 质量评分标准
|
||||
|
||||
| 维度 | 分值 | 说明 |
|
||||
|------|------|------|
|
||||
| 长度适当 | 25 | 不过长不过短 |
|
||||
| 章节完整 | 25 | 包含关键章节 |
|
||||
| 格式质量 | 20 | 清晰的 Markdown |
|
||||
| 内容具体 | 15 | 有针对性 |
|
||||
| 模块化 | 15 | 分文件组织 |
|
||||
|
||||
**及格线**：65/100
|
||||
**优秀线**：85/100
|
||||
|
||||
---
|
||||
|
||||
## ⚡ 高级技巧
|
||||
|
||||
### 1. 使用 Hooks 自动化
|
||||
|
||||
```json
|
||||
// .claude/hooks/session-start.json
|
||||
{
|
||||
"hook": "SessionStart",
|
||||
"handler": "check-claude-md.sh"
|
||||
}
|
||||
```
|
||||
|
||||
### 2. 权限管理
|
||||
|
||||
```json
|
||||
// .claude/settings.local.json
|
||||
{
|
||||
"permissions": {
|
||||
"allow": ["Read", "Write", "Edit", "Bash"],
|
||||
"ask": ["WebFetch"],
|
||||
"deny": ["WebSearch"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. 多项目共享
|
||||
|
||||
```bash
|
||||
# 全局 CLAUDE.md（所有项目生效）
|
||||
~/.claude/CLAUDE.md
|
||||
|
||||
# 项目级 CLAUDE.md
|
||||
project/CLAUDE.md
|
||||
|
||||
# 组件级 CLAUDE.md
|
||||
project/frontend/CLAUDE.md
|
||||
```
|
||||
|
||||
### 4. 上下文优化
|
||||
|
||||
- 定期使用 `/compact` 压缩上下文
|
||||
- 保持 CLAUDE.md 简洁（100-200 行）
|
||||
- 使用模块化文件（backend/CLAUDE.md, frontend/CLAUDE.md）
|
||||
|
||||
---
|
||||
|
||||
## 📚 学习路径
|
||||
|
||||
```
|
||||
入门 → 安装 → 基础对话 → CLAUDE.md
|
||||
↓
|
||||
进阶 → 子代理 → Skills → Hooks
|
||||
↓
|
||||
高级 → batch 命令 → Agent Teams → 自动化
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 相关资源
|
||||
|
||||
| 资源 | 链接 |
|
||||
|------|------|
|
||||
| 官方文档 | https://code.claude.com/docs |
|
||||
| 最佳实践 | https://github.com/shanraisshan/claude-code-best-practice |
|
||||
| ClaudeForge | https://github.com/alirezarezvani/ClaudeForge |
|
||||
| awesome-claude-md | https://github.com/josix/awesome-claude-md |
|
||||
| CLAUDE.md 模板 | https://github.com/abhishekray07/claude-md-templates |
|
||||
|
||||
---
|
||||
|
||||
## AI工程索引
|
||||
|
||||
相关笔记：
|
||||
- [[INDEX_AI工程]] - AI工程知识索引
|
||||
- [[ClaudeCode完全研究]] - Claude Code 完整指南
|
||||
- [[claude-code-best-practice详解]] - 最佳实践详解
|
||||
|
||||
---
|
||||
|
||||
*整理：知识库管理员 | 归档：2026-04-23*
|
||||
Reference in New Issue
Block a user