CodeGPT 是一个 Visual Studio Code 扩展,它让你能够通过 OpenAI 官方 API 利用 GPT-3(生成式预训练转换器)模型生成、解释、重构和记录各种编程语言的代码片段。此 Visual Studio Code 扩展让你可以在编辑器中使用 OpenAI 的官方 API,借助 GPT- 3 或 ChatGPT 生成代码或自然语言回答,来解答你的问题。
借助人工智能提升你的编程能力!自动编写新代码、提出问题、获取解释、重构代码、发现错误等。
CodeGPT 可应用于多种任务,包括代码补全、生成和格式化。它还可以集成到代码编辑器和集成开发环境(IDE)中,为开发者提供 AI 辅助编码功能。
本教程将指导你如何在 Visual Studio Code(一款广泛使用的代码编辑器)中配置和使用 CodeGPT。
安装 CodeGPT
在开始使用 Visual Studio Code IDE 中的 CodeGPT 之前,你需要先进行安装。
要安装 CodeGPT 扩展,首先请确保你已经安装了 Visual Studio Code 编辑器。如果尚未安装,可以访问其官方网站下载并安装适用于你操作系统的版本。
安装完毕后,打开 Visual Studio Code 编辑器,在左侧边栏中找到 Extensions(扩展)图标,点击进入扩展商店。在扩展商店的搜索栏中输入“codegpt”进行搜索。在搜索结果中找到经过验证的 CodeGPT 扩展,通常这个扩展会显示在搜索结果的顶部。在扩展的详情页面中,仔细阅读描述和相关信息,以确保这是你所需的扩展。
当你确认找到了正确的 CodeGPT 扩展后,点击安装按钮以添加此扩展到 Visual Studio Code 编辑器。安装过程可能需要一段时间,请耐心等待。安装完成后,你可能需要重启 Visual Studio Code 编辑器以使扩展生效。
点击安装按钮将使 CodeGPT 在你的 Visual Studio 代码编辑器中可用。
另外,你也可以通过 Visual Studio 市场手动安装 CodeGPT。
配置 CodeGPT
在 Visual Studio 代码编辑器中成功安装 CodeGPT 后,你必须用你的 OpenAI API 密钥配置 CodeGPT。
要检索您的 OpenAI API 密钥,请导航到 https://beta.openai.com/account/api-keys,并点击创建新的密匙按钮,如下图所示。
点击此按钮将生成你的 API 密匙。注意,你需要在密钥生成后立即复制并安全地存储,因为 OpenAI 不会再显示它们。
接下来,回到 Visual Studio 代码编辑器,导航到 设置。
在 macOS 上,导航到菜单栏,点击Code,然后选择Preferences,找到设置选项。在 Windows 上,按 ctrl+,
以打开你的设置。
在设置搜索栏中输入“codegpt”来过滤其他设置,以快速查看 CodeGPT 设置。
在 macOS 上,按 cmd+shift+p 并搜索“CodeGPT: Set API KEY“来添加你的 API 密钥。在 windows 上,在 API 密钥选项下填写。
CodeGPT 扩展有几个其他的设置,可以根据你的喜好来配置它。
它们包括:
- Max Tokens:在 API 处理提示信息之前,输入被分解成令牌。然后 API 处理这些令牌。最大令牌是 API 应该接受和处理的最大令牌数。因此,根据你想得到的响应长度,选择令牌的数量。同样重要的是要注意,每个模型(后面会有更多关于模型的内容)都有一个最大数量的令牌,所以你使用的模型对最大令牌的数量起作用。
- Model:这是 OpenAI 模型,CodeGPT 在处理查询时将使用该模型。顾名思义,CodeGPT 使用 GPT- 3 模型。在这个模型中,
text-davinci-003
是最有能力的,因为它能够提供更高的质量,更多的输出,正确地遵循 prompts,并处理多达 4000 个标记。 - Language:这是你将与 API 互动的语言。解释或文件等功能也将在所选语言中进行。
- Temperature:这个设置决定了生成文本的随机性或“创造性”水平。temperature 越高,生成的输出就越多样,越有创造性。较低的 temperature 会导致输出与训练数据相似,不太可能包含意外或令人惊讶的内容。它是一个介于零(0)和(1)之间的值,零是最确定的,(1)是最随机和最有创意的。默认 temperature 为 0.3。
让我们来探讨一下你可以用 CodeGPT 做的各种事情以及如何做这些事情。
生成代码
你可以使用 CodeGPT 根据你在 Visual Studio 代码编辑器中的提示来生成代码片段。
要用 CodeGPT 生成代码,写一个要求特定代码的注释(请确保将光标保持在同一注释行的末尾),在 macOS 上按 cmd + shift + i
。在 windows 上,按ctrl + shift + i
。按这组键将触发 CodeGPT 提示,然后它在左边打开一个新窗口,显示你的提示结果。
在下面的例子中,提示“Generate a function that returns a UUID in JavaScript using ES6 syntax with comments(使用带注释的 ES6 语法生成一个在 JavaScript 中返回 UUID 的函数)”,被用来生成第二个窗口中的代码片段。
上面的提示产生了一个很好的解释(有注释)的函数,生成了一个 UUID。
解释代码
你可以使用 CodeGPT 来解释代码片段,你需要帮助理解它们的作用。
要解释一个代码片段,突出显示该代码片段,然后右键单击。右键单击将显示一些选项。在这些选项中,选择Explain CodeGPT。
点击这个选项会触发 CodeGPT 提示,并打开一个新的窗口,显示提示的结果,如下图所示。
上面例子中的提示产生了一个正确的解释,该函数使用 regex 验证一个电子邮件地址是否有效。
重构代码
你可以使用 CodeGPT 来重构代码片段,使其更可读、更可维护、更高效。
要重构一个代码片段,突出显示该代码片段,然后右键单击。右键单击将显示一些选项。在这些选项中,选择Refactor CodeGPT。
点击这个选项会触发 CodeGPT 提示,并打开一个新的窗口,显示提示的结果,如下图所示。
上面例子中的提示重构了突出显示的代码块,使用 reduce
数组方法来计算购物车中产品的总价格。最初的代码块(重构前)使用 for-loop
来计算产品的总价格。
上面例子中的提示为先前重构的函数写了单元测试,以确保它产生预期的结果。
探索 CodeGPT
以下是 CodeGPT 的主要特点
- 生成代码:你只需要输入一个要求特定代码的注释,然后按
cmd-shift-i
,CodeGPT 就会打开一个新窗口,里面有代码。
- 解释代码:选择一些代码,右击它并选择“Explain CodeGPT”选项。CodeGPT 将打开一个新的窗口并解释该代码。
下面是结果
但这还不是全部! 下面是你可以用 CodeGPT 做的其他事情:
- 提出问题
- 重构代码
- 记录代码
- 查找代码中的问题
总的来说,CodeGPT 是一款强大的工具,能够帮助开发者完成各种任务,例如记录代码、诊断问题以及从 Stack Overflow 获取答案。然而,在使用 AI 生成的代码时,不要忘了它可能存在的局限性。为确保代码质量和满足需求,采取必要的预防措施,如进行测试,是至关重要的。
尽管 CodeGPT 存在一定的局限性,但它有潜力提升开发者的生产力和效率。随着技术的不断发展,我们可以期待未来会出现更多令人激动的进步。AI 辅助编程的潜力在于帮助开发者专注于更高层次的创新和设计,而不是陷入繁琐的编程细节。即便如此,在使用 CodeGPT 等工具时,我们仍需保持审慎,确保代码的安全性和可靠性。
让我们积极拥抱 AI 技术的持续发展,并充分利用这些工具来提高我们的编程能力。同时,不要忘记关注 AI 领域的最新进展,以便我们在这个快速发展的领域保持领先地位。