VS Code 中使用 GitHub Copilot 进行代码补全
GitHub Copilot 充当人工智能驱动的结对程序员,自动提供建议来完成你的代码、注释、测试等。它在你编写代码时直接在编辑器中提供这些建议,并且可以与各种编程语言和框架协同工作。
Copilot 提供两种类型的建议
-
代码补全 - 在编辑器中开始输入,Copilot 提供与你编码风格匹配并考虑现有代码的代码建议。
-
下一个编辑建议 - 使用 Copilot 下一个编辑建议(也称为 Copilot NES)预测你的下一个代码编辑。根据你正在进行的编辑,NES 既预测你想要进行的下一个编辑的位置,又预测该编辑应该是什么。
入门
-
安装 GitHub Copilot 扩展。
-
使用你的 GitHub 帐户登录以使用 Copilot。
提示如果你还没有 Copilot 订阅,可以通过注册 Copilot 免费计划 免费使用 Copilot,并获得每月完成次数和聊天交互的限制。
-
通过我们的 Copilot 快速入门 了解 VS Code 中 Copilot 的主要功能。
行内建议
Copilot 在你输入时提供代码建议:有时是当前行的补全,有时是全新的代码块。你可以接受全部或部分建议,也可以继续输入并忽略建议。
请注意以下示例中 Copilot 如何使用变暗的幽灵文本建议 calculateDaysBetweenDates
JavaScript 函数的实现
当出现行内建议时,你可以使用 Tab 键接受它。
Copilot 尝试为代码建议应用与你代码中已有的编码风格相同的风格。请注意以下示例中 Copilot 如何为建议的 subtract
方法应用与 add
方法相同的输入参数命名方案。
部分接受建议
你可能不希望接受 GitHub Copilot 的所有建议。你可以使用 ⌘→ (Windows, Linux Ctrl+Right) 键盘快捷键接受建议的下一个单词或下一行。
替代建议
对于任何给定输入,Copilot 可能会提供多个替代建议。你可以将鼠标悬停在建议上以查看其他建议。
从代码注释生成建议
你可以通过使用代码注释来提供关于你期望的代码的提示,而不是依赖 Copilot 提供建议。例如,你可以指定要使用的算法类型或概念(例如,“使用递归”或“使用单例模式”),或者要添加到类中的方法和属性。
以下示例演示了如何指示 Copilot 在 TypeScript 中创建一个类来表示学生,提供有关方法和属性的信息
下一个编辑建议
行内建议在自动完成代码片段方面表现出色。但由于大多数编码活动是编辑现有代码,因此 Copilot 代码补全的自然演进是也帮助编辑,无论是在光标处还是更远的地方。编辑通常不是孤立进行的 - 在不同的场景中需要进行编辑的逻辑流。Copilot 下一个编辑建议 (Copilot NES) 是这种演进。
根据你正在进行的编辑,Copilot NES 既预测你想要进行的下一个编辑的位置,又预测该编辑应该是什么。Copilot NES 帮助你保持流畅,建议与你当前工作相关的未来更改,你可以简单地按 Tab 键快速导航并接受 Copilot 的建议。建议可能跨越单个符号、整行或多行,具体取决于潜在更改的范围。
要开始使用 Copilot NES,请启用 VS Code 设置 github.copilot.nextEditSuggestions.enabled。
导航和接受编辑建议
你可以使用 Tab 键快速导航到建议的代码更改,从而节省查找下一个相关编辑的时间(无需手动搜索文件或引用)。然后,你可以再次使用 Tab 键接受建议。
如果存在编辑建议,沟槽中的箭头会指示。你可以将鼠标悬停在箭头上以探索编辑建议菜单,其中包含键盘快捷键和设置配置
如果编辑建议低于当前编辑器视图,箭头将向下而不是向右指向
如果您是 VS Code vim 扩展 用户,请使用最新版本的扩展以避免与 NES 的键绑定冲突。
通过编辑建议减少干扰
默认情况下,编辑建议由沟槽箭头指示,并且代码更改显示在编辑器中。如果你喜欢减少干扰,你可以禁用在编辑器中显示代码更改,直到你按下 Tab 键导航到建议或直到你将鼠标悬停在沟槽箭头上方。
要禁用在编辑器中显示代码更改,请在设置编辑器中启用 editor.inlineSuggest.edits.showCollapsed 设置。或者,将鼠标悬停在沟槽箭头上,然后从菜单中选择显示折叠选项。要重新启用显示代码更改,请禁用该设置或从沟槽箭头菜单中选择显示展开。
下一个编辑建议的用例
捕获和纠正错误
-
Copilot 帮助纠正简单的错误,例如拼写错误。 它会建议修复字母缺失或交换的地方,例如
cont x = 5
或conts x = 5
,它们本应是const x = 5
。 -
Copilot 还可以帮助解决更具挑战性的逻辑错误,例如倒置的三元表达式
或者一个应该使用
&&
而不是||
的比较
更改意图
-
Copilot 建议更改代码的其余部分,以匹配意图的新变化。 例如,当将一个类从
Point
更改为Point3D
时,Copilot 会建议向类定义中添加一个z
变量。接受更改后,Copilot NES 接下来建议将z
添加到距离计算中
重构
-
在一个文件中重命名一个变量,Copilot 会建议在其他所有地方更新它。 如果你使用新的名称或命名模式,Copilot 会建议类似地更新后续代码。
-
匹配代码风格。复制粘贴一些代码后,Copilot 会建议如何调整它以匹配粘贴发生处的当前代码。
启用或禁用代码补全
你可以为所有语言或仅为特定语言启用或禁用代码补全。
-
要启用或禁用代码补全,请选择状态栏中的 Copilot 菜单,然后选中或取消选中选项以启用或禁用代码补全。
禁用特定语言代码补全的选项取决于活动编辑器的语言。
-
或者,修改设置编辑器中的 github.copilot.enable 设置。
为要启用或禁用代码补全的每种语言添加一个条目。要为所有语言启用或禁用代码补全,请将
*
的值设置为true
或false
。
通过小睡功能,你可以暂时禁用编辑器中的所有代码补全。要小睡代码补全,请选择状态栏中的 Copilot 菜单,然后选择小睡按钮以将小睡时间增加五分钟。要恢复代码补全,请选择 Copilot 菜单中的取消小睡按钮。
或者,使用命令面板中的小睡行内建议和取消小睡行内建议命令。
更改补全的 AI 模型
不同的语言大模型 (LLM) 在不同类型的数据上进行训练,并且可能具有不同的能力和优势。了解如何在 VS Code 中 选择不同的 AI 语言模型。
要更改用于在编辑器中生成代码补全的语言模型
-
打开命令面板 (F1)。
-
键入更改补全模型并选择GitHub Copilot: 更改补全模型命令。
-
在下拉菜单中,选择要使用的模型。
或者,如果启用了命令中心,您可以单击 VS Code 标题栏中的 Copilot 菜单,然后在下拉菜单中单击配置代码补全。然后,在下拉菜单中选择更改补全模型...并选择要使用的模型。
可用模型列表可能会随时间变化。模型选择器可能不会总是显示多个模型,并且预览模型和其他代码补全模型将在我们发布时可用。如果您是 Copilot Business 或 Enterprise 用户,您的管理员需要通过在 GitHub.com 的 Copilot 策略设置 中选择编辑器预览功能
来为您的组织启用某些模型。
提示与技巧
上下文
为了给你提供相关的行内建议,Copilot 会查看编辑器中当前和打开的文件,以分析上下文并创建适当的建议。在使用 Copilot 时,在 VS Code 中打开相关文件有助于设置此上下文,并让 Copilot 更全面地了解你的项目。
设置
代码补全设置
-
github.copilot.enable - 启用或禁用所有语言或特定语言的行内补全。
-
editor.inlineSuggest.fontFamily - 配置行内补全的字体。
-
editor.inlineSuggest.showToolbar - 启用或禁用行内补全出现的工具栏。
-
editor.inlineSuggest.syntaxHighlightingEnabled - 启用或禁用行内补全的语法高亮。
下一个编辑建议设置
-
github.copilot.nextEditSuggestions.enabled - 启用 Copilot 下一个编辑建议 (Copilot NES)。
-
editor.inlineSuggest.edits.allowCodeShifting - 配置 Copilot NES 是否能够移动你的代码以显示建议。
-
editor.inlineSuggest.edits.renderSideBySide - 配置 Copilot NES 是否可以尽可能并排显示较大的建议,或者 Copilot NES 是否应该始终在相关代码下方显示较大的建议。
- 自动(默认):如果视口中有足够的空间,则并排显示较大的编辑建议,否则在相关代码下方显示建议。
- 从不:从不并排显示建议,始终在相关代码下方显示建议。
后续步骤
-
通过 Copilot 快速入门 发现主要功能。
-
使用 Copilot Chat 进行 AI 聊天对话。
-
在 YouTube 上观看我们的 VS Code Copilot 系列 视频。