---
sidebar_position: 1
---

# 概述

欢迎使用 AI 编码指南！本章节介绍如何使用 Wegent 的 AI 驱动编码功能来自动化软件开发任务。

<img src="https://github.com/user-attachments/assets/cc25c415-d3f1-4e9f-a64c-1d2614d69c7d" width="100%" alt="Code Mode Demo"/>

---

## 目录

- [功能概述](#功能概述)
- [核心特性](#核心特性)
- [快速开始](#快速开始)
- [文档导航](#文档导航)
- [最佳实践](#最佳实践)

---

## 功能概述

AI 编码是 Wegent 的核心功能，它使 AI 智能体能够在您的 Git 仓库中编写、修改和管理代码。与简单的聊天交互不同，AI 编码任务会连接到您的代码仓库，并通过提交和拉取请求进行真实的代码变更。

**核心概念**：
```
代码任务 = 用户提示词 + 代码智能体 + Git 仓库 + 工作台
```

### 工作原理

1. **选择代码智能体**：选择配置了代码类型 Shell（如 ClaudeCode）的智能体
2. **连接仓库**：关联您的 GitHub 或 GitLab 仓库
3. **描述任务**：提供清晰的任务描述
4. **AI 执行**：智能体克隆仓库、进行修改并提交代码
5. **查看结果**：使用工作台查看变更、差异对比，并创建 PR

---

## 核心特性

### Git 集成
- **GitHub 和 GitLab 支持**：通过 OAuth 或个人访问令牌连接仓库
- **分支管理**：AI 为每个任务创建功能分支
- **提交历史**：通过详细的提交信息追踪 AI 的所有变更
- **拉取请求创建**：轻松从已完成的任务创建 PR

### 工作台面板
工作台是一个专用面板，提供对编码任务的实时可视化：

| 标签页 | 描述 |
|--------|------|
| **概览** | 任务状态、仓库信息、执行时间线和摘要 |
| **文件变更** | 查看所有修改的文件，带语法高亮的差异对比 |
| **预览** | Web 应用的实时预览（如果可用） |

### 执行时间线
实时观察 AI 的思考过程：
- **工具使用**：查看 AI 正在使用的工具（Read、Edit、Write、Bash 等）
- **进度追踪**：通过可视化指示器监控任务进度
- **思考过程**：了解 AI 的决策过程

### 代码审查功能
- **差异查看器**：并排或统一视图查看所有变更
- **文件统计**：每个文件的新增/删除行数
- **提交详情**：查看单个提交的作者和时间戳

---

## 快速开始

### 前置条件

使用 AI 编码前，请确保：

1. **已配置 Git 令牌**：在设置中配置您的 GitHub 或 GitLab 访问令牌
2. **有可用的代码智能体**：至少有一个配置了代码类型 Shell 的智能体
3. **仓库访问权限**：确保您的令牌有权访问目标仓库

### 快速入门

1. **进入 Code 页面**：点击左侧导航栏的"Code"
2. **选择智能体**：从下拉菜单中选择具有代码能力的智能体
3. **选择仓库**：选择目标仓库和分支
4. **输入任务**：描述您希望 AI 完成的工作
5. **发送并监控**：提交任务并在工作台中观察进度

### 示例任务

以下是一些入门示例提示词：

```
添加一个使用 JWT 令牌的用户认证功能
```

```
重构数据库模块以使用连接池
```

```
修复支付处理中出现重复扣款的 bug
```

```
为 UserService 类添加单元测试，覆盖率至少 80%
```

---

## 文档导航

| 文档 | 描述 |
|------|------|
| [管理代码任务](./managing-code-tasks.md) | 创建、执行和管理编码任务 |
| [需求澄清模式](./spec-clarification-guide.md) | 将模糊需求精炼为清晰任务 |

---

## 最佳实践

### 1. 编写清晰的提示词

**✅ 好的提示词**：
```
添加一个 REST API 端点 POST /api/users，要求：
- 接受包含 name、email 和 password 的 JSON 请求体
- 验证邮箱格式和密码强度
- 成功时返回 201 和用户 ID
- 验证失败时返回 400 和错误信息
```

**❌ 模糊的提示词**：
```
添加用户创建功能
```

### 2. 复杂任务使用需求澄清

对于复杂或模糊的需求，使用[需求澄清模式](./spec-clarification-guide.md)功能，通过交互式问答在开始编码任务前精炼您的需求。

### 3. 合并前审查变更

始终在工作台中审查 AI 的变更：
- 检查每个修改文件的差异
- 验证提交信息是否准确
- 如有需要，在本地测试变更
- 创建 PR 供团队审查

### 4. 拆分大型任务

不要创建一个庞大的任务，而是拆分成更小、更专注的任务：

**不要这样做**：
```
构建一个完整的电商系统
```

**应该这样做**：
```
任务 1：创建产品目录 API 端点
任务 2：实现购物车功能
任务 3：添加结账和支付处理
任务 4：构建订单管理系统
```

### 5. 提供上下文

在提示词中包含相关上下文：
- 引用现有的代码模式
- 提及特定的文件或模块
- 指定编码标准或约定
- 包含验收标准

---

## 相关资源

- [智能体设置](../settings/agent-settings.md) - 配置代码智能体
- [配置模型](../settings/configuring-models.md) - 设置 AI 模型
- [配置 Shell](../settings/configuring-shells.md) - 配置执行环境
- [核心概念](../../concepts/core-concepts.md) - 了解 Wegent 架构

---

## 获取帮助

需要帮助？

- 📖 查看 [常见问题](../../faq.md)
- 🐛 提交 [GitHub Issue](https://github.com/AntGroup/Wegent/issues)
- 💬 加入社区讨论

---

<p align="center">开始使用 AI 编码，提升您的开发效率！🚀</p>
