GitHub Copilot 在 VS Code 中的速查表
Visual Studio Code 中的 GitHub Copilot 提供了 AI 驱动的功能，可帮助您更快、更轻松地编写代码。本速查表快速概述了 Visual Studio Code 中 GitHub Copilot 的功能。
您可以通过聊天视图、直接在编辑器中、从集成终端以及通过 VS Code 用户界面中的 AI 驱动的增强功能访问 VS Code 中的 GitHub Copilot。
如果您还没有 Copilot 订阅，您可以通过注册 Copilot 免费计划 免费使用 Copilot，并获得每月有限的完成次数和聊天互动次数。
该团队正在不断努力改进 VS Code 中的 Copilot 并添加新功能。某些功能仍处于实验阶段。试用它们并在 我们的问题 中分享您的反馈。
与 GitHub Copilot 聊天
使用自然语言与 GitHub Copilot 聊天，并获得编码任务方面的帮助。例如，要求 Copilot 解释一段代码或一个编程概念。获取有关使用 Copilot 聊天 的更多信息。
| 操作 | 描述 |
|---|---|
| ⌃⌘I (Windows, Linux Ctrl+Alt+I) | 打开聊天视图。 |
| ⇧⌥⌘L (Windows, Linux Ctrl+Shift+Alt+L) | 打开快速聊天，并向 Copilot 提出快速问题。 |
| ⌘I (Windows, Linux Ctrl+I) | 启动内联聊天，直接从编辑器向 Copilot 发送聊天请求。使用自然语言或使用 / 命令向 Copilot 发出指令。 |
| ⌘. (Windows, Linux Ctrl+.) | 在聊天视图中切换不同的 聊天模式。 |
添加上下文... |
将不同类型的上下文附加到您的聊天提示。 |
/explain |
要求 Copilot 解释一段代码或一个编程概念。 |
| 访问您的聊天会话历史记录。 | |
| 使用语音（语音聊天）输入聊天提示。聊天回复将大声朗读。 |
提示
- 使用
/命令和@参与者以获得更精确和相关的答案。- 具体一点，保持简单，并提出后续问题以获得最佳结果。
- 通过将文件、符号或选定内容附加到您的聊天提示来提供上下文。
- 选择合适的聊天模式：提问、编辑或代理模式。
从聊天生成代码
Copilot 可以在回复您的聊天提示时生成代码块。快速将生成的代码应用到您的项目中，或将其插入到新文件中。例如，要求 Copilot 优化您代码中的算法。
| 操作 | 描述 |
|---|---|
| 智能应用在活动编辑器中生成的代码块。 | |
| 将生成的代码块插入到光标处。 | |
| 将生成的代码块复制到剪贴板。 | |
| 将生成的代码块作为 shell 命令插入到终端中。 |
提示
- 提供有关要使用的框架或库的详细信息。
- 考虑创建自定义代码生成指令。
将上下文附加到您的提示
当您向 Copilot 发送聊天提示时，您可以附加上下文以帮助 Copilot 更好地理解您的问题。例如，将当前编辑器选择、文件或符号添加到您的聊天提示。获取有关 使用 Copilot 的最佳实践 的更多信息。
| 操作 | 描述 |
|---|---|
| 添加上下文 | 打开快速选择，以选择与您的聊天提示相关的上下文。从不同的上下文类型中选择，例如工作区文件、符号、当前编辑器选择、终端选择等。 |
提示... （实验性） |
将可重用的 提示指令 添加到您的请求。 |
| 拖放文件 | 将文件或编辑器选项卡拖放到聊天中以将文件附加为上下文。 |
| 拖放文件夹 | 将文件夹拖放到聊天中以将文件夹中的文件附加为上下文。 |
| 拖放问题 | 从问题面板中拖放项目以将其附加为上下文。 |
| 最近的文件（实验性） | 自动将最近打开和编辑的文件包含在您的聊天提示中。获取更多信息。 |
聊天变量
在您的聊天提示中使用聊天变量来引用与您的问题相关的上下文。
| 聊天变量 | 描述 |
|---|---|
#changes |
源代码管理更改列表。 |
#codebase |
将相关工作区内容作为上下文添加到您的提示中。 |
#fetch |
从网页获取内容 - 提供 URL。 |
#file |
打开快速选择以从您的工作区中选择文件并将其添加为提示的上下文。 |
#<filename> |
键入 #，后跟文件名，以获取工作区文件的文件名建议并附加为上下文。 |
#folder |
键入 #folder:，后跟文件夹名称以从您的工作区中选择文件夹并将其添加为提示的上下文。添加文件夹会将文件夹中的所有文件作为上下文添加。 |
#problems |
从问题面板中添加工作区问题和错误作为上下文。在修复代码或调试时很有用。 |
#searchResults |
将来自“搜索”视图的结果作为上下文添加到您的提示中。 |
#selection |
将当前编辑器选择作为上下文添加到您的提示中。 |
#sym |
打开快速选择以从您的工作区中选择符号并将其添加为提示的上下文。 |
#<symbol> |
键入 #，后跟符号名称，以获取工作区文件的符号建议并附加为上下文。 |
#terminalSelection |
将当前终端选择作为上下文添加到您的聊天提示中。 |
#terminalLastCommand |
将上次运行的终端命令作为上下文添加到您的聊天提示中。 |
#testFailure |
添加测试失败信息作为上下文。在运行和诊断测试时很有用。 |
#usages |
“查找所有引用”、“查找实现”和“转到定义”的组合。 |
#VSCodeAPI |
将 VS Code API 作为上下文添加到您的提示中，以询问与 VS Code 扩展开发相关的问题。 |
编辑器中的 Copilot
当您在编辑器中编写代码时，您可以使用 Copilot 在您键入时生成代码完成。调用内联聊天以向 Copilot 提问并获得帮助，同时保持编码流程。例如，要求 Copilot 为函数或方法生成单元测试。获取有关代码完成和内联聊天的更多信息。
| 操作 | 描述 |
|---|---|
| 代码完成 | 在编辑器中开始键入，Copilot 会提供与您的编码风格匹配并考虑您现有代码的代码建议。 |
| 代码注释 | 通过在代码注释中编写指令，向 Copilot 提供代码完成提示。 示例： # 编写一个计算器类，其中包含用于加法、减法和乘法的方法。使用静态方法。 |
| 下一个编辑建议 | 使用 Copilot 下一个编辑建议预测您的下一个代码编辑。使用 github.copilot.nextEditSuggestions.enabled 设置启用 Copilot NES。了解如何开始使用 Copilot NES。 |
| ⌘I (Windows, Linux Ctrl+I) | 启动内联聊天，直接从编辑器向 Copilot 发送聊天请求。使用自然语言或使用 / 命令向 Copilot 发出指令。 |
| F2 | 在重命名代码中的符号时获取 AI 驱动的建议。 |
提示
- 使用有意义的方法或函数名称，以便更快地获得更好的代码完成。
- 选择一个代码块以限定您的内联聊天提示的范围，或通过附加文件或符号来附加相关上下文。
- 使用编辑器上下文菜单选项直接从编辑器访问常用的 Copilot 操作。
自定义 AI 代码生成
定义自定义指令，以帮助 Copilot 生成或审查与您的团队或项目的编码风格、工具和开发人员工作流程相匹配的代码。
借助可重用的提示文件，您可以在 Markdown 文件 (*.prompt.md) 中指定常用的提示指令和相关内容，然后在您的聊天提示中重复使用它们。
| 操作 | 描述 |
|---|---|
| 基于文件的指令 | 在您的工作区中的 .github/copilot-instructions.md 文件中定义代码生成的共享指令。这些通用指令补充了您自己的个人代码生成指令。 |
| 代码审查指令（预览） | 定义使用 Copilot 审查设置中编辑器选择的指令，或从文件导入。您可以定义特定于语言的指令。 |
| 代码生成指令（实验性） | 定义在设置中使用 GitHub Copilot 进行代码生成的指令，或从文件导入。您可以定义特定于语言的指令。 |
| 测试生成指令（实验性） | 定义在设置中使用 GitHub Copilot 进行测试生成的指令，或从文件导入。您可以定义特定于语言的指令。 |
| 提交消息生成指令（实验性） | 定义在设置中使用 GitHub Copilot 进行提交消息生成的指令，或从文件导入。您可以定义特定于语言的指令。 |
| 拉取请求标题和描述生成指令（实验性） | 定义在设置中使用 GitHub Copilot 生成拉取请求标题和描述的指令，或从文件导入。您可以定义特定于语言的指令。 |
| 可重用的提示文件（实验性） | 定义可重用的提示指令，用于在 Markdown 文件中使用其他上下文执行可重复的任务，并在聊天提示中使用它们。 |
提示
- 定义特定于语言的指令，以便为每种语言获得更准确的生成代码。
- 将您的指令存储在文件中，以便轻松地与您的团队和跨项目共享它们。
代码审查（实验性）
Copilot 可以快速审查代码块，或对工作区中未提交的更改执行审查。审查反馈以注释的形式显示在编辑器中，您可以在其中应用建议。
| 操作 | 描述 |
|---|---|
| 审查和评论 （预览） | 选择一个代码块，然后从编辑器上下文菜单中选择 Copilot > 审查和评论 以进行快速审查。 |
| Copilot 代码审查 | 在“源代码管理”视图中选择 Copilot 代码审查 按钮，以对所有未提交的更改进行更深入的审查。加入等待列表。 |
生成测试
Copilot 可以为代码库中的函数和方法生成测试。获取有关聊天中的斜杠命令的更多信息。
| 操作 | 描述 |
|---|---|
/tests |
为编辑器中的所有或仅选定的方法和函数生成测试。生成的测试将附加到现有的测试文件中，或者创建一个新的测试文件。 |
/setupTests |
获取有关为您的代码设置测试框架的帮助。获取有关相关测试框架的建议、设置和配置步骤以及 VS Code 测试扩展的建议。 |
/fixTestFailure |
询问 Copilot 关于如何修复失败的测试的建议。 |
| 测试覆盖率（实验性） | 为尚未被测试覆盖的函数和方法生成测试。获取更多信息。 |
提示
- 提供有关要使用的测试框架或库的详细信息。
生成文档
为代码库中的函数和方法生成代码文档。获取有关聊天中的斜杠命令的更多信息。
| 操作 | 描述 |
|---|---|
/docs |
为编辑器中的所有或仅选定的方法和函数生成文档注释。 |
调试和修复问题
使用 Copilot 帮助修复编码问题，并获得有关在 VS Code 中配置和启动调试会话的帮助。
| 操作 | 描述 |
|---|---|
/fix |
询问 Copilot 关于如何修复一段代码或如何解决代码中的任何编译器或代码检查错误的建议。例如，帮助修复未解析的 Node.js 包名称。 |
/fixTestFailure |
询问 Copilot 关于如何修复失败的测试的建议。 |
/startDebugging （实验性） |
生成 launch.json 调试配置文件并从聊天视图启动调试会话。 |
copilot-debug 命令 |
终端命令，帮助您调试您的程序。在运行命令前添加前缀以启动其调试会话（例如，copilot-debug python foo.py）。 |
提示
- 提供有关您需要的修复类型的其他信息，例如优化内存消耗或性能。
- 留意编辑器中的 Copilot 代码操作，这些操作指示修复代码中问题的建议。
搭建新项目
Copilot 可以通过生成项目结构的支架或根据您的要求生成笔记本，来帮助您创建新项目。
| 操作 | 描述 |
|---|---|
/new |
在聊天视图中使用 /new 命令来搭建新项目或新文件。使用自然语言描述您需要的项目/文件的类型，并在创建之前预览搭建的内容。示例： /new 使用 typescript 和 svelte 的 Express 应用程序 |
/newNotebook |
在聊天视图中使用 /newNotebook 命令根据您的要求生成新的 Jupyter 笔记本。使用自然语言描述笔记本应包含的内容。示例： /newNotebook 获取人口普查数据并使用 Seaborn 预览关键见解。 |
源代码管理和问题
Copilot 可以分析您的提交和拉取请求中的更改，并为提交消息和拉取请求描述提供建议。
| 操作 | 描述 |
|---|---|
| 提交 | 为源代码管理提交中的当前更改生成提交消息。 |
| 拉取请求 | 生成与您的拉取请求中的更改相对应的拉取请求标题和描述。 |
@github |
在聊天中使用 @github 参与者询问有关您存储库中的问题、拉取请求等。获取有关可用的 GitHub 技能的更多信息。示例： @github 分配给我的所有打开的 PR 是什么？，@github 显示来自 @dancing-mona 的最近合并的 pr |
搜索
使用 Copilot 在“搜索”视图中获得更相关的搜索结果。
| 操作 | 描述 |
|---|---|
| 语义搜索（实验性） | 在“搜索”视图中包含来自 Copilot 的搜索结果，这些结果与您的查询在语义上相关。 |
终端
获得有关 shell 命令以及如何在终端中运行命令时解决错误的帮助。
| 操作 | 描述 |
|---|---|
| ⌘I (Windows, Linux Ctrl+I) | 在终端中启动内联聊天，以使用自然语言快速获取和运行 shell 命令。 示例： 这台机器上有多少个核心？ |
@terminal |
在聊天视图中使用 @terminal 参与者询问有关集成终端或 shell 命令的问题。示例： @terminal 列出此工作区中 5 个最大的文件 |
@terminal /explain |
在聊天视图中使用 /explain 命令来解释终端中的某些内容。示例： @terminal /explain top shell 命令 |
Python 和笔记本支持
您可以使用聊天来帮助您完成 Native Python REPL 和 Jupyter 笔记本中的 Python 编程任务。
| 操作 | 描述 |
|---|---|
| 生成 ⌘I (Windows, Linux Ctrl+I) |
在笔记本中启动内联聊天以生成代码块或 Markdown 块。 |
# |
在您的聊天提示中附加来自 Jupyter 内核的变量，以获得更相关的回复。 |
| Native REPL + ⌘I (Windows, Linux Ctrl+I) | 在 Native Python REPL 中启动内联聊天并运行生成的命令。 |
| ⌃⌘I (Windows, Linux Ctrl+Alt+I) | 打开聊天视图并使用编辑或代理模式进行笔记本编辑。 |
/newNotebook |
在聊天视图中使用 /newNotebook 命令根据您的要求生成新的 Jupyter 笔记本。使用自然语言描述笔记本应包含的内容。示例： /newNotebook 获取人口普查数据并使用 Seaborn 预览关键见解。 |
VS Code 命令和 API
您可以使用 Copilot 获得有关 VS Code 功能、设置和 VS Code 扩展 API 的帮助。获取有关聊天参与者的更多信息。
| 操作 | 描述 |
|---|---|
@vscode |
使用 @vscode 聊天参与者通过使用自然语言询问有关 VS Code 的问题。示例： @vscode 如何启用自动换行？ |
@vscode /runCommand |
将 /runCommand 与 @vscode 聊天参与者一起使用以运行 VS Code 命令。@vscode /runCommand 启用开发者模式 |
@vscode /search |
将 /search 与 @vscode 聊天参与者一起使用以生成 VS Code 搜索。示例： @vscode /search 没有导入的 python 文件 |
提示
- 如果您询问有关 VS Code 扩展 API 的问题，请使用
#vscodeAPI聊天变量。
RSS Feed
Ask questions
Follow @code
Request features
Report issues
Watch videos