通义灵码，作为智能编码助手，可以在你进行编码工作时，为你提供行级/函数级实时续写、注释生成代码、单元测试生成、代码优化、注释生成、代码解释、研发智能问答、代码问题修复等辅助编码工作的功能。
- 通义灵码，是基于通义大模型的智能编程辅助工具，提供行级/函数级实时续写、自然语言生成代码、单元测试生成、代码优化、注释生成、代码解释、研发智能问答、异常报错排查等能力，并针对阿里云的云服务使用场景调优，助力开发者高效、流畅地编码。点击进入通义灵码官网>>
- 通义灵码支持 JetBrains IDEs、Visual Studio Code、Visual Studio，及远程开发场景（Remote SSH、Docker、WSL、Web IDE），安装后登录账号即可开始使用。点击安装指南
如果你是通义灵码新用户，我们为新用户赠送定制超大鼠标垫，完成通义灵码安装体验，即可领取。
完成步骤与邮寄信息登记：https://survey.taobao.com/apps/zhiliao/wHHnILAYI
如果你想在移动端第一时间了解通义灵码使用技巧与最佳实践，也非常欢迎大家关注【通义灵码】公众号。
一、安装指南
JetBrains IDEs 中安装指南
本安装步骤适用于 macOS、Windows 或 Linux 的 JetBrains IDEs 中安装通义灵码。
在 JetBrains IDEs 中安装通义灵码
Tips：以在 IntelliJ IDEA 中安装通义灵码为例。
方法 1：从插件市场安装
- 打开 IntelliJ IDEA 设置窗口，在插件市场中搜索 TONGYI Lingma，找到通义灵码后单击安装。
- 安装完成后，请重启 IntelliJ IDEA。
方法 2：下载安装包安装
- 单击下方链接，下载 JetBrains IDEs 的 zip 安装包；
⇩ TONGYI Lingma - JetBrains - 下载完安装包后，打开 IntelliJ IDEA 后，打开设置，在插件管理的设置下拉菜单中单击从本地安装插件，选择下载的 zip 文件后安装。
- 安装完成后，请重启 IntelliJ IDEA。
登录并开启智能编码之旅
重启 IntelliJ IDEA 后，单击侧边导航的通义灵码，在通义灵码助手的窗口单击登录按钮。
- 单击登录后，将前往登录页面，完成登录后可进入 IDE 客户端开始使用。登录相关具体操作，可参考：登录通义灵码插件端。
Visual Studio Code 中安装指南
本安装步骤适用于 macOS、Windows 或 Linux 的 Visual Studio Code 中安装通义灵码。
在 Visual Studio Code 中安装通义灵码
方法 1：从插件市场安装
说明
单击立即安装，唤起 Visual Studio Code 插件市场直接安装，安装后请重启 IDE，即可开启智能编码之旅。
- 打开 Visual Studio Code 扩展窗口，搜索 TONGYI Lingma，找到通义灵码后单击安装。
- 安装完成后，请重启 Visual Studio Code。
方法 2：下载安装包安装
- 单击下方链接，下载 Visual Studio Code 的 VSIX 安装包；
⇩ TONGYI Lingma-VS Code - 下载完安装包后，打开 Visual Studio Code 后，单击扩展，单击更多按钮，在下拉菜单中单击 从 VSIX 安装，选择下载的 VSIX 文件后安装；
- 安装完成后，请重启 Visual Studio Code。
登录并开启智能编码之旅
重启 Visual Studio Code 后，单击侧边导航的通义灵码，在通义灵码助手的窗口单击登录按钮。
Tips：如果安装后在侧边导航上找不到通义灵码入口，可鼠标聚焦在侧边导航后右键查看，勾选通义灵码后即可将插件入口配置在侧边导航上。
- 单击登录后，将前往登录页面，完成登录后可进入 IDE 客户端开始使用。登录相关具体操作，可参考：登录通义灵码插件端。
Visual Studio 中安装指南
本安装步骤适用于 Windows 10 及以上操作系统中安装和使用通义灵码。
在 Visual Studio 中安装通义灵码
方法 1：从插件市场安装
- 打开 Visual Studio 顶部扩展-管理扩展窗口，搜索 TONGYI Lingma，找到通义灵码后单击安装。
- 安装完成后，请重启 Visual Studio。
方法 2：下载安装包安装
- 单击下方链接，下载 Visual Studio 的 VSIX 安装包；
⇩ TONGYI Lingma - Visual Studio 2022
⇩ TONGYI Lingma - Visual Studio 2019 - 关闭已经打开的 Visual Studio 2022 或 Visual Studio 2019；
- 下载完安装包后，找到该通义灵码的安装包（以 VSIX 为扩展名），双击安装包，按照安装向导操作即可。
登录并开启智能编码之旅
- 重启 Visual Studio 后，单击顶部导航工具
- 单击登录后，将前往登录页面，完成登录后可前往 IDE 客户端开始使用。登录相关具体操作，可参考：登录通义灵码插件端。
二、功能展示
1. 代码智能补全
1.1 行级/函数级实时补全
当你在 IDE 编辑器区进行代码编写时，在开启自动云端生成的模式下，通义灵码会根据当前代码文件及相关代码文件的上下文，自动为你生成行级/函数级的代码建议，此时你可以使用快捷键采纳、废弃，或查看不同的代码建议。
同时，当你在编码的过程中，也可以通过快捷键 ⌥ P 手动触发生成代码建议。
编辑器中代码建议相关操作的快捷键如下：
操作 |
macOS |
Windows |
接受行间代码建议 |
|
|
废弃行间代码建议 |
|
|
查看上一个行间推荐结果 |
|
|
查看下一个行间推荐结果 |
|
|
手动触发行间代码建议 |
|
|
Tips：不同操作系统的快捷键配置可查看插件配置指南。
1.2 自然语言生成代码
在编辑器中，可以直接通过自然语言的方式描述需要实现的需求，通义灵码可以在编辑器中生成代码建议，单击 Tab 可直接采纳。
2. 研发智能问答
使用通义灵码的智能问答时，为了通义灵码与你的对话能够更友好、高效，希望你能够在输入问题时：
- 选中代码，开始输入你的问题，通义灵码将围绕着选中代码与你开展对话；
- 精准表达问题，以及给出相对详细的上下文输入， 比如选中的代码、日志、报错信息等；
- 多多互动，告诉通义灵码，所给出代码建议或回答是否满足你的预期，或生成内容存在的具体瑕疵，通义灵码也会不断改进。
2.1 研发自由问答
当你编码遇到问题，缺乏具体解决思路时，可单击 IDE 侧边工具导航或使用⌘ ⇧ L唤起通义灵码智能问答助手，无需离开 IDE 客户端，即可快速获得答案和解决思路。
2.2 代码问答
当你对某段代码有疑问或期望针对代码进行一些问题解决时，选中代码后，在智能问答窗口的输入框中输入你的问题，通义灵码将围绕选中代码与你开展对话。
2.3 @workspace 本地工程问答
当你需要快速了解一个工程、查找工程内的实现逻辑，或有新的诉求需要进行代码变更时，可以在智能问答窗口中通过 @ 可唤起 @workspace，选中后输入你的问题或诉求，通义灵码可快速结合当前仓库进行工程理解、代码查询、代码问答等，同时可以通过自然语言描述需求，结合当前工程生成简单需求或缺陷的整体修改建议和相关建议代码。
2.4 @terminal 问答
当你遇到执行指令不知道如何写，或者不清楚某个指令的意思时，可以在智能问答窗口中通过 @ 可唤起 @terminal，选择后使用自然语言描述你的需要指令诉求，通义灵码将可以生成你需要的命令。生成指令后，你可以一键插入到 teminal 中进行执行或让通义灵码继续解释。当然，你也可以在选择 @terminal 后，输入指令让通义灵码生成指令解释。
2.5 #team docs 知识库问答（企业版）
当你需要结合企业内私域知识信息让通义灵码进行回答时，可以在智能问答窗口中通过 # 唤起 #team docs，并输入问题，通义灵码将结合企业知识库（当前用户有权限的知识库）对问题进行回答，在回复中也可以单击查看引用的企业知识库内容。
2.6 清空会话上下文历史记忆
当你在会话中是，在智能问答输入框中输入 / 即可看到 /clear context 指令，选择后即可清空当前会话的上下文历史记忆。
2.7 新建会话
在智能问答窗口中，单击右上角的新建按钮即可新建会话窗口，单击后会话窗口将回到默认状态。
2.8 查看会话历史
历史会话功能帮助你检索和回顾与通义灵码的交流记录，方便针对多次的建议进行对比和选择。不管你在哪个 IDE 客户端上、哪个工程中，均可以查看或搜索你和通义灵码的历史会话。
3. 智能生成指令
3.1 指令触发方式
通义灵码提供多处触发单元测试生成、代码解释、生成代码注释、代码优化功能的入口，当你选中的代码后，有 3 种触发方式：
- 在编辑器中，单击右键找到通义灵码功能操作入口，单击对应功能操作；
- 在智能问答中，直接单击对应功能操作；
- 在智能问答中，使用
/查看快捷指令，单击对应功能操作。
当需要针对一个方法实现生成单元测试、代码注释、代码解释、代码优化时，无需选中代码，可直接单击函数上方的快捷入口触发相关功能操作。
3.2 选择指令后输入回答要求
当你选中代码后，并通过在智能问答窗口的输入框输入 / 的方式选中指令后，可以继续输入附加的要求，比如：
- 选择
/generate unit test后，继续输入你对单元测试生成的要求，比如使用 JUnit 5生成； - 选择
/generate comment后，继续输入生成注释的要求，比如开头标明日期，并用英文注释。
3.3 指令一：解释代码
覆盖各种编程语言，选中代码后可自动识别编程语言并生成代码解释。跨越语言的边界，让你阅读代码更高效。
3.4 指令二：生成单元测试
支持根据 JUnit、Mockito、Spring Test、unit test、pytest 等框架生成单元测试。
3.5 指令三：生成注释
一键生成方法注释及行间注释，节省你写代码注释的时间，并能够有效提升代码可读性。
3.6 指令四：代码优化
深度分析代码及其上下文，迅速识别潜在的编码问题，从简单的语法错误到复杂的性能瓶颈，均能够指出问题所在，并提供具体的优化建议代码。
3.7 生成回答后快捷操作
针对不同的指令生成回答后，在智能问答区中，可以继续根据诉求进行操作，不同功能的对应操作如下：
- 生成单元测试：
- 采纳单元测试代码建议：支持一键插入、复制、或者新建代码文件，可快速采纳生成的单元测试代码建议；
- 更换单元测试框架：提供基于 JUnit、Mockito、Spring Test、unit test、pytest 等框架生成单元测试代码建议，在回答完成后，可以根据需要切换框架重新生成；
- 新建文件：支持一键保存单元测试代码为新文件，方便进行查看和修改。
- 生成代码优化建议
- 采纳代码优化建议：针对优化建议中的建议代码，支持一键插入、复制，快速采纳生成的建议代码；
- 查看 Diff：单击查看 Diff 按钮，将快速唤起 IDE Diff 查看窗口，快速了解建议和源代码的变更；
- 生成代码注释：
- 采纳代码注释建议：支持一键插入、复制，可快速采纳生成的代码注释建议；
- 查看 Diff：单击查看 Diff 按钮，将快速唤起 IDE Diff 查看窗口，快速了解建议和源代码的变更。
- 解释代码：
- 支持重试、更详细、更简单、中文/英文解释的追问。
4. 问题修复建议
4.1 代码问题（Problem）一键修复
当你在编码过程中出现代码问题（Problem）需要进行修复时，通义灵码可以一键给出修复建议，帮你快速修复代码问题。可以通过编辑器中报错图标中下拉菜单中或 Problem 窗口中聚焦到报错信息后右键菜单中，单击通义灵码一键修复菜单，即可生成修复建议和相关建议代码。
4.2 异常报错排查（IntelliJ IDEA）
在 IntelliJ IDEA 中，当运行出现异常报错时，在运行标准输出窗口中，即可看到通义灵码的快捷操作按钮，单击后，通义灵码将结合运行代码、异常堆栈等报错上下文，快速给出排查思路或修复建议。
4.3 执行报错、编译报错排查（Visual Studio Code）
在 Visual Studio Code 中，当 terminal 中执行指令后报错、编译或运行后有大量报错，需要进行解释或修复时，可以选中报错信息，右键选择使用通义灵码一键解释，也会为你生成相关命令解释及问题解决建议。
5. 提交信息生成
当你有代码变更需要提交，需要写提交信息时，可以通过通义灵码一键生成 Git 提交信息，同时可以在插件设置中配置生成的语言（英文/中文）。
6. 离线单行补全
通义灵码代码补全默认使用云端大模型进行智能续写，当网络情况有限制时，可使用本地补全模式，单击状态栏图标切换至本地补全模式后，编辑器中进行编码时，通义灵码会给出单行的代码建议。
7. IntelliJ IDEA 中技术文档和代码片段搜索
在 IntelliJ IDEA 客户端内，如果你在编码过程中有需要进行技术资料检索、代码片段搜索时，无须离开 IDE，单击侧边导航的通义灵码，单击搜索，即可开始搜索。
8. 查看帮助和分享反馈
8.1 查看使用帮助
通义灵码的智能问答窗口中，可以通过 2 种方式查看使用帮助：
- 通过智能问答的
/help指令快捷查看使用帮助；
- 单击智能问答窗口的帮助文档入口，可以快速来到当前帮助文档知识库。
8.2 反馈回答质量
在智能问答中，你可以对通义灵码所生成的回答内容进行评价，支持点赞和点踩，以不断优化回答效果。
8.3 使用问题反馈
当你在使用的过程有任何疑问、优化建议、功能诉求等，均可在通义灵码的智能问答窗口单击提交反馈，即可前往阿里云开发者社区-通义灵码问答专区向我们提出问题。
新用户福利：
欢迎下载通义灵码，体验 AI 编码魅力。新用户领取定制鼠标垫，登记信息方便工作人员确认：https://survey.taobao.com/apps/zhiliao/wHHnILAYI
