VS Code快速编写代码生成插件CodeGeeX使用指南

       CodeGeeX是一个具有130亿参数的多编程语言代码生成预训练模型，使用超过二十种编程语言训练得到。基于CodeGeeX开发的插件可以实现通过描述生成代码、补全代码、代码翻译等一系列功能。CodeGeeX同样提供可以定制的提示模式（Prompt Mode），构建专属的编程助手。Happy Coding！

VS Code插件市场搜索"CodeGeex"即可免费使用(需要VS Code版本不低于1.68.0)，更多关于CodeGeeX信息请私信。

如使用过程中遇到问题或有任何改进意见，欢迎发送建议到Wx：18634371151反馈！

---

基本用法

需要保证VS Code版本 >= 1.68.0。安装插件并全局激活CodeGeeX，有以下四种使用模式：

• 自动模式: 保持CodeGeeX处于激活状态，当您停止输入时，会从当前光标处开始生成（右下角CodeGeeX图标转圈表示正在生成）。 生成完毕之后会以灰色显示，按Tab即可插入生成结果。
• 交互模式: 按Ctrl+Enter激活交互模式，CodeGeeX将生成X个候选，并显示在右侧窗口中（X 数量可以在设置的Candidate Num中修改）。 点击候选代码上方的use code即可插入。
• 翻译模式: 选择代码，然后按下Ctrl+Alt+T激活翻译模式，CodeGeeX会把该代码翻译成匹配您当前编辑器语言的代码。点击翻译结果上方的use code插入。您还可以在设置中选择您希望插入的时候如何处理被翻译的代码，您可以选择注释它们或者覆盖它们。
• 提示模式（实验功能）: 选择需要作为输入的代码，按Alt/Option+t触发提示模式，会显示预定义模板列表，选择其中一个模板，即可将代码插入到模板中进行生成。 这个模式高度自定义，可以在设置中 Prompt Templates修改或添加模板内容，为模型加入额外的提示。

隐私声明

      我们高度尊重用户代码的隐私，代码仅用来辅助编程。在您第一次使用时，我们会询问您是否同意将生成的代码用于研究用途，帮助CodeGeeX变得更好（该选项默认关闭）。

使用指南

      以下是CodeGeeX几种模式的详细用法： 

      1、自动模式

         保持CodeGeeX处于激活状态，当您停止输入时，会从当前光标处开始生成（右下角CodeGeeX图标转圈表示正在生成）。 生成完毕之后会以灰色显示，按Tab即可插入生成结果。

          具体操作步骤：CodeGeeX将在您停止输入时，从光标处开始生成（右下角CodeGeeX图标转圈表示正在生成）。生成完毕之后会以灰色显示，如果您对结果满意，按“Tab”即可插入生成结果。，时长02:30在生成多个候选的情况下，可以使用“Alt/Option+[“ 或 ”]”在几个候选间进行切换。用户也可以在设置中改变“Candidate Num”。如果您对现有建议不满意，可使用“Alt/Option+N”获得新的候选。

        2、交互模式 

           具体操作步骤：通过“Ctrl+Enter”激活交互模式，CodeGeeX将生成“X”个候选，并显示在右侧窗口中（“X” 数量可以在设置的“Candidate Num”中修改）。点击候选代码上方的“use code”即可插入结果到为当前光标位置。

        3、翻译模式

      该模式可帮助您将一种语言翻译成另一种语言，例如将用C++写的某个算法翻译成Python，而不用自己再敲一遍。 

      选择代码，然后按下Ctrl+Alt+T激活翻译模式，CodeGeeX会把该代码翻译成匹配您当前编辑器语言的代码。点击翻译结果上方的use code插入。您还可以在设置中选择您希望插入的时候如何处理被翻译的代码，您可以选择注释它们或者覆盖它们。

         4、提示模式

       该模式可模仿已输入代码实现相应功能，如快速对大段代码进行解释。该模式的原理是利用CodeGeeX强大的少样本生成能力。         

       选择需要作为输入的代码，按Alt/Option+t触发提示模式，会显示预定义模板列表，选择其中一个模板，即可将代码插入到模板中进行生成。 这个模式高度自定义，可以在设置中 Prompt Templates修改或添加模板内容，为模型加入额外的提示。 

---

         模板文件是高度自定义化的，您可以将自定义模板添加到插件设置中的“Prompt Templates”中。“key”表示模板的名字， “value”是模板文件的路径（此路径不唯一，可以是您电脑上的任一路径，“.txt”,“.py”,“.h”等格式文件均可）。