JetBrains IDEs / Android Studio 插件使用指南
驭码CodeRider 为开发者提供自然语言生成代码、代码补全、代码调优纠错、单元测试生成、代码解释以及智能技术问答等功能。CodeRider 与 GitLab 深度融合，为企业提供软件开发全生命周期（SDLC）的支持，涵盖企业文档库/代码仓智能问答、议题管理、合并请求智能辅助、代码智能评审、流水线管理等功能。
说明：在 IDE 环境中使用 CodeRider，需要先完成 CodeRider 的安装与登录，相关说明请参考：JetBrains IDEs / Android Studio 安装与登录指南。
1. 代码智能生成/补全
1.1 代码智能实时补全
当您在 IDE 中编写代码时，在开启代码补全功能的情况下，CodeRider 会根据当前代码文件及相关代码文件内容自动为您实时补全代码，此时您可以使用快捷键接纳代码建议，也可以废弃当前代码建议。
当您开启代码补全增强模式时，CodeRider 会根据您当前代码仓库内容为您推荐更符合业务场景和编程风格的代码建议。代码补全模式设置请参考JetBrains IDEs / Android Studio 插件配置指南。
IDE 中代码补全相关操作快捷键默认如下，如您需修改快捷键配置，请参考 JetBrains IDEs / Android Studio 插件配置指南。
| 操作 | macOS | Windows |
|---|---|---|
| 接受全部建议 | Tab | Tab |
| 废弃建议 | esc | Esc |
| 单行模式：多行补全 | ⌥ + M | Alt + M |
1.2 自然语言生成代码
您可以在 IDE 中使用自然语言描述您的编程需求，CodeRider 将根据需求指令生成代码建议。
在编辑器中生成代码时，CodeRider 将参考当前代码文件、整个项目仓相关代码内容（增强模式下）自动为您生成代码。您可以使用快捷键逐片段或整个模块接纳生成代码，也可以废弃当前代码建议。（快捷键及模式设置参考“代码智能实时补全”。）
在对话框中生成代码时，您可直接输入自然语言需求，CodeRider 将生成对应代码建议。特别地，当您“@代码仓知识库”并输入需求时，CodeRider 将针对指定的代码仓内容结合需求指令生成代码。您可以点击“在光标处插入”直接将生成代码插入到光标停留位置。
2. 智能辅助编程
2.1 项目引导
CodeRider 为项目提供快速引导功能，帮助您快速上手项目代码。
注：当前项目必须已创建为代码知识库，否则该功能无法使用。关于代码知识库的创建请参考 JetBrains IDEs / Android Studio 插件配置指南。
2.2 代码解释
CodeRider 自动识别选中代码的编程语言并生成代码解释，帮助您更高效地阅读和理解代码。
2.3 代码注释
CodeRider 为所选代码片段生成行间注释，提升代码的可读性，帮助您快速阅读代码。
2.4 代码修改
CodeRider 根据您输入的代码修改指令完成对选中代码的修改，帮助您快速完成代码优化。
2.5 单元测试
CodeRider 为所选代码片段生成单元测试代码，帮助您准确、高效地测试函数或代码片段。
为有较好的使用体验，请先创建并标注您的测试资源根目录。
2.6 代码优化
CodeRider 为所选代码片段生成改进建议及参考优化代码，以提升代码的可读性、可维护性、安全性等，帮助您生成更优美的代码。
2.7 问题快速修复
当 IDE 检测到错误的代码并标红时，光标停留于错误代码位置，通过 ⌥ + Enter（macOS）或 Alt + Enter（Windows）即可唤醒 CodeRider 快速修复。
3. 智能 DevOps 助手
说明：CodeRider 提供智能 DevOps 辅助功能，包含对项目史诗、议题、合并请求、代码片段、漏洞的管理，支持用户在 IDE 中配置 DevOps 助手操作界面，配置方式请参考 JetBrains IDEs / Android Studio 插件配置指南。
3.1 处理议题
使用该功能，需要确保您当前打开的项目托管在连接的 GitLab 实例上。
CodeRider 支持在议题中生成讨论内容概览，快速清晰地给出议题结论，帮助用户高效地阅读议题信息，提升工作效率。生成的议题摘要，您可以双击修改，并一键评论到议题讨论内容中，同步给当前议题的所有用户。
3.2 生成提交信息
CodeRider 支持为提交的代码生成提交信息。同时，您可以设置提交信息的语言，设置方式参考 JetBrains IDEs / Android Studio 插件配置指南。
注：对于当前更改有且仅有新增的文件，由于无法建立跟踪，因此针对此类暂存无法生成提交信息。
3.3 代码预审核
CodeRider 支持在提交修改代码前进行代码预审核，帮助您将代码评审前置，提交高质量的代码，提升开发效率。
注：对于新增的文件，由于无法建立跟踪，因此针对此类变更文件无法使用代码预审核。
3.4 处理合并请求
使用该功能，需要确保您当前打开的项目托管在连接的 GitLab 实例上。
CodeRider 支持在合并请求中生成内容摘要，包含合并请求的概述、变更内容、影响范围、预期结果等。生成的合并请求摘要，您可以双击修改，并一键评论到合并请求内容中，同步给合并请求提交者。
3.5 文件级代码智能审核
使用该功能，需要确保您当前打开的项目托管在连接的 GitLab 实例上，且单个文件上限不超过 10000 字符。
CodeRider 支持在 IDE 中审核提交的合并请求，同时支持在 IDE 中查看合并请求修改前后的对比代码，并可添加评审建议。
CodeRider 支持文件级代码评审，即可针对当前合并请求生成逐文件级的代码评审建议，您可以双击修改，并一键将当前文件或 MR 中所有文件的评审建议评论到 MR 内容中，将评审建议同步给合并请求提交者。
4. 智能问答
- IDE 中唤醒智能问答窗口的快捷键默认如下，如您需修改快捷键配置，请参考 JetBrains IDEs / Android Studio 插件配置指南。
| 操作 | macOS | Windows |
|---|---|---|
| 唤醒智能问答窗口 | ⌥ + ⌘ + / | Ctrl + Alt + / |
4.1 自然语言多轮技术问答
当配置模型生效后，您可以灵活选择本地模型、云端模型、私有模型（企业私有化部署用户）来完成研发技术问答，您无需离开编程界面即可使用 CodeRider 解决研发中的技术难题。同时，CodeRider 支持多轮对话问答，能够快速响应开发人员的问题，并提供准确的解决方案。另外，当您需要针对代码片段提问时，请先将对应代码片段粘贴到对话输入框，并输入相关问题。
CodeRider 会在当前会话框首次聊天时，生成会话标题摘要。同时，支持在“历史记录”界面修改会话标题。
4.2 知识库问答
CodeRider 支持基于云端模型、私有模型（私有化部署企业）的企业知识库功能，拥有访客及以上权限的用户可以在对话框 “@” 知识库名称，并针对知识库内容进行技术问答。CodeRider 支持同时引用不超过 3 个知识库进行问答。同时，CodeRider 支持您配置自己的知识库，包括创建、更新、设置别名、删除，配置操作请参考 JetBrains IDEs / Android Studio 插件配置指南。
4.3 企业代码问答
CodeRider 支持基于云端模型、私有模型（私有化部署企业）的企业代码问答功能，拥有访客及以上权限的用户可以在对话框 “@” 代码知识库名称，并针对代码知识库内容进行技术问答。CodeRider 支持同时引用不超过 3 个知识库进行问答。同时，CodeRider 支持您配置自己的代码知识库，包括创建、更新、设置别名、删除，配置操作请参考 JetBrains IDEs / Android Studio 插件配置指南。
5. 规则
JetBrains IDEs / Android Studio 插件版本 2.1.0 以上支持规则功能使用。 规则适用功能：Chat、Loom 对话。 不适用功能：代码补全、代码优化、代码修改、单元测试、代码注释、生成提交信息、Issue 总结、MR 总结、代码评审。
5.1 规则类型及生效方式
CodeRider 支持项目规则与用户规则的设定，同时支持企业管理员为企业用户配置项目规则模版。
- 项目规则模版由企业管理员配置，企业用户在 IDE 中可下载、修改项目规则模版。单个项目规则模版最大限制为 1000 字符。
- 项目规则被存储在 .coderider/rules 目录下，仅针对当前工程生效，可跟随项目代码一同通过 GitLab 做版本共享和同步。单个项目规则最大限制为 1000 字符。
- 用户规则由用户创建并维护，跨设备可同步。用户规则最大限制为 1000 字符。
规则类型及生效方式：
| 规则 | 类型 | 生效范围 | 限制 |
|---|---|---|---|
| 项目规则 | Auto 模式 | Loom、Chat 模式下对话自动生效。 | 单个项目中，Auto + Loom + Chat 模式同时最多 5 个可生效；单次对话中，Manual 模式的规则最多可手动选择 5 个生效。 |
| Loom 模式 | Loom 模式下自动生效。 | ||
| Chat 模式 | Chat 模式下自动生效。 | ||
| Manual 模式 | Loom 和 Chat 模式下手动 @规则时生效。 | ||
| 用户规则 | -- | 当前用户生效，跨设备可同步 | 单个用户最多可创建并维护 1 个用户规则 |
5.2 规则设置与使用
- 规则设置
- 单击“CodeRider 设置”-->“规则与记忆”。
- 在规则配置界面，用户可下载企业管理员已配置的项目规则模版，并将模版进行修改以使用。
- 用户可在 IDE 中单击新建项目规则，设置规则名称、选择规则类型，并跳转规则文件输入内容。
- 用户可在对应的项目规则卡片上，单击“编辑”或“删除”以实现对已有规则的编辑、删除操作。
- 在“用户规则”模块输入规则内容，并“确认”即可保存当前输入的用户规则并生效。
-
规则使用
Auto、Loom、Chat 模式的规则，在 Chat 或 Loom 模式下对话自动生效。Manual 模式的规则，用户需在 Chat 或 Loom 模式下 @规则 方可生效。
6. 记忆
CodeRider 提供了记忆功能，包含项目记忆、用户记忆。在开发者与 Loom 的交互过程中会逐渐形成针对个人、项目的丰富记忆，并自动进行相关的记忆更新。
6.1 用户记忆
用户记忆包含用户日常工作的使用习惯记录，包含：用户个人信息和配置、用户交互行为规范与风格偏好、用户技术栈与工程模式，及其他用户偏好记忆。
- 用户记忆创建/更新
用户记忆仅支持在 Loom “执行”模式下创建，用户在与 Loom 交互过程中会自动被记录使用习惯。如需主动要求某习惯被记住，可以尝试在 Loom 输入“帮我记住…”，如“帮我记住我喜欢用 Python”。
- 用户记忆使用
CodeRider 支持在“CodeRider 设置”->“规则与记忆”页面配置用户记忆的生效范围。若用户同时勾选 Loom 与 Chat 启用时，在使用 Loom 与对话功能时将自动结合用户记忆生成回复内容。
- 用户记忆查看与编辑
CodeRider 支持用户查看并手动编辑用户记忆内容。在“CodeRider 设置”->“规则与记忆”页面，单击对应记忆维度卡片的“编辑”按钮，即可进行记忆内容编辑。
注：
- 用户记忆内容上限为 1000 字，请不要超出字数限制。
- 用户仅可编辑记忆内容，记忆名称、标签不可编辑。用户编辑记忆内容后，可能会导致内容与标签不匹配的情况，在下次自动更新时会根据内容更新标签。
- 跨设备同步方式
CodeRider 用户记忆支持跨设备同步，用户可单击“上传用户记忆内容”或“下载用户记忆内容”实现记忆的跨设备同步。
6.2 项目记忆
项目记忆描述当前项目的基本信息，包含：项目概述、项目功能、项目架构、项目技术选型、项目目录结构、近期工作、进度。项目记忆跟随当前项目代码仓进行管理和维护。
- 项目记忆创建/更新
项目记忆仅支持在 Loom “执行”模式下手动创建、更新，若需要创建当前项目的项目记忆，请输入“创建项目记忆”；若需要更新当前项目的项目记忆，请输入“更新项目记忆”。
- 项目记忆使用
CodeRider 支持在“CodeRider 设置”->“规则与记忆”页面配置用户记忆的生效范围。开启 Chat 模式生效后，“项目引导”指令将优先参考项目记忆内容。开启 Loom 模式生效后，Loom 执行相关任务将优先参考项目记忆内容。
- 项目记忆查看与编辑
CodeRider 支持用户查看并手动编辑项目记忆内容。在“CodeRider 设置”->“规则与记忆”页面，单击“项目信息与进展”的“编辑”按钮，即可进行记忆内容编辑。
注：
- 项目记忆内容上限为 5000 字，请不要超出字数限制。
- 用户仅可编辑记忆内容，记忆名称不可编辑。
7. MCP
CodeRider 会根据用户在 Loom 中输入的提示词，结合 MCP 工具的名字及描述，调用所需 MCP 工具，并返回结果。
