VS Code 中的 GitHub Copilot 备忘单
Visual Studio Code 中的 GitHub Copilot 提供由 AI 驱动的功能,可帮助您更快、更轻松地编写代码。此备忘单快速概述了 Visual Studio Code 中 GitHub Copilot 的功能。
如果你还没有 Copilot 订阅,可以通过注册 Copilot 免费计划 免费使用 Copilot,并获得每月限量的补全和聊天交互次数。
基本键盘快捷键
- ⌃⌘I (Windows, Linux Ctrl+Alt+I) - 打开聊天视图
- ⌘I (Windows, Linux Ctrl+I) - 在聊天视图中输入语音聊天提示
- ⌘N (Windows, Linux Ctrl+N) - 在聊天视图中开始新的聊天会话
- ⇧⌘I (Windows Ctrl+Shift+I, Linux Ctrl+Shift+Alt+I) - 切换到代理模式
- ⌘I (Windows, Linux Ctrl+I) - 在编辑器或终端中开始内联聊天
- ⌘I (Windows, Linux Ctrl+I) (按住) - 开始内联语音聊天
- Tab - 接受内联建议或导航到下一个编辑建议
- Escape - 放弃内联建议
在 VS Code 中访问 AI
-
使用自然语言开始聊天对话
- 聊天视图 (⌃⌘I (Windows, Linux Ctrl+Alt+I)):在辅助侧边栏中进行持续聊天对话
- 编辑器或终端中的内联聊天 (⌘I (Windows, Linux Ctrl+I)):在流程中提问
- 快速聊天 (⇧⌥⌘L (Windows, Linux Ctrl+Shift+Alt+L)):在不离开当前任务的情况下快速提问
-
编辑器中的 AI
- 代码补全:在您键入时获取建议,按 Tab 接受建议
- 编辑上下文菜单操作:访问常见的 AI 操作,例如解释或修复代码、生成测试或审阅文本选择
- 代码操作:获取编辑器代码操作 (灯泡) 以修复 linting 和编译器错误
-
VS Code 中针对特定任务的智能操作
- 生成提交消息以及拉取请求标题和描述
- 修复测试错误
- 语义文件搜索建议
VS Code 中的聊天体验
开始自然语言聊天对话以获取编码任务帮助。例如,请求解释代码块或编程概念、重构一段代码或实现新功能。获取有关使用 Copilot Chat 的更多信息。
| 操作 | 描述 |
|---|---|
| ⌃⌘I(Windows、Linux Ctrl+Alt+I) | 在辅助侧边栏中打开 聊天视图。 |
| ⌘I(Windows、Linux Ctrl+I) | 开始内联聊天以在编辑器或终端中打开聊天。 |
| ⇧⌥⌘L(Windows、Linux Ctrl+Shift+Alt+L) | 打开快速聊天而不会中断您的工作流程。 |
| ⌘N (Windows, Linux Ctrl+N) | 在聊天视图中开始新的聊天会话。 |
| 在聊天视图中切换不同的聊天模式。 | |
| ⌥⌘. (Windows, Linux Ctrl+Alt+.) | 显示模型选择器以选择不同的 AI 模型进行聊天。 |
添加上下文... |
将不同类型的上下文附加到您的聊天提示中。 |
/-命令 |
使用斜杠命令执行常见任务或调用可重用聊天提示。 |
#-提及 |
引用常用工具或聊天变量,以在提示中提供上下文。 |
@-提及 |
引用聊天参与者以处理特定领域请求。 |
| 编辑 () | 编辑之前的聊天提示并还原更改。 |
| 历史记录 () | 访问您的聊天会话历史记录。 |
| 语音 () | 通过语音 (语音聊天) 输入聊天提示。聊天回复会朗读出来。 |
| KaTeX | 在聊天回复中渲染数学方程。通过 chat.math.enabled 启用。 |
提示
- 使用
#-提及为您的聊天提示添加更多上下文。- 使用
/命令和@参与者获取更精确和相关的答案。- 具体、简单,并提出后续问题以获得最佳结果。
- 选择适合您需求的聊天模式:提问、编辑、代理或创建自定义模式。
向您的提示添加上下文
通过为您的聊天提示提供上下文来获取更相关的回复。从不同上下文类型中选择,例如文件、符号、编辑器选择、源代码管理提交、测试失败等。
| 操作 | 描述 |
|---|---|
| 添加上下文 | 打开快速选择器以选择与您的聊天提示相关的上下文。从不同上下文类型中选择,例如工作区文件、符号、当前编辑器选择、终端选择等。 |
| 拖放文件 | 从资源管理器或搜索视图中拖放文件,或将编辑器选项卡拖到聊天视图中。 |
| 拖放文件夹 | 将文件夹拖放到聊天视图中以附加其中的文件。 |
| 拖放问题 | 从“问题”面板中拖放项目。 |
#<文件|文件夹|符号> |
键入 #,后跟文件、文件夹或符号名称,以将其添加为聊天上下文。 |
| `#-提及 | 键入 #,后跟聊天工具以添加特定的上下文类型或工具。 |
聊天工具
在聊天中使用工具以在处理用户请求时完成专门任务。此类任务的示例包括列出目录中的文件、编辑工作区中的文件、运行终端命令、获取终端输出等。选择内置工具或来自 MCP 服务器和扩展的工具。
下表列出了 VS Code 内置工具
| 聊天变量/工具 | 描述 |
|---|---|
#changes |
源代码管理更改列表。 |
#codebase |
在当前工作区中执行代码搜索,以自动查找聊天提示的相关上下文。 |
#createAndRunTask |
在工作区中创建并运行新的任务。 |
#createDirectory |
在工作区中创建新目录。 |
#createFile |
在工作区中创建新文件。 |
#edit (工具集) |
启用工作区中的修改。 |
#editFiles |
将编辑应用于工作区中的文件。 |
#editNotebook |
编辑笔记本。 |
#extensions |
搜索并询问有关 VS Code 扩展的问题。例如,“如何开始使用 Python #extensions?” |
#fetch |
从给定网页中获取内容。例如,“总结 #fetch code.visualstudio.com/updates。” |
#fileSearch |
使用 glob 模式在工作区中搜索文件并返回其路径。 |
#getNotebookSummary |
获取笔记本单元格及其详细信息的列表。 |
#getProjectSetupInfo |
提供构建不同类型项目的说明和配置。 |
#getTaskOutput |
获取在工作区中运行任务的输出。 |
#getTerminalOutput |
获取在工作区中运行终端命令的输出。 |
#githubRepo |
在 GitHub 存储库中执行代码搜索。例如,“什么是全局片段 #githubRepo microsoft/vscode。” |
#installExtension |
安装 VS Code 扩展。 |
#listDirectory |
列出工作区中目录中的文件。 |
#new |
构建新的 VS Code 工作区,预配置调试和运行配置。 |
#newJupyterNotebook |
根据描述构建新的 Jupyter 笔记本。 |
#newWorkspace |
创建新工作区。 |
#openSimpleBrowser |
打开内置的简单浏览器并预览本地部署的 Web 应用。 |
#problems |
从问题面板中添加工作区问题和错误作为上下文。在修复代码或调试时很有用。 |
#readFile |
读取工作区中文件的内容。 |
#readNotebookCellOutput |
读取笔记本单元格执行的输出。 |
#runCell |
运行笔记本单元格。 |
#runCommands (工具集) |
启用在终端中运行命令和读取输出。 |
#runInTerminal |
在集成终端中运行 shell 命令。 |
#runNotebooks (工具集) |
启用运行笔记本单元格。 |
#runTask |
运行工作区中现有任务。 |
#runTasks (工具集) |
启用在工作区中运行任务和读取输出。 |
#runTests |
在工作区中运行单元测试。 |
#runVscodeCommand |
运行 VS Code 命令。例如,“启用禅模式 #runVscodeCommand。” |
#search (工具集) |
启用在当前工作区中搜索文件。 |
#searchResults |
获取搜索视图中的搜索结果。 |
#selection |
获取当前编辑器选择 (仅当文本被选中时可用)。 |
#terminalLastCommand |
获取上次运行的终端命令及其输出。 |
#terminalSelection |
获取当前终端选择。 |
#testFailure |
获取单元测试失败信息。在运行和诊断测试时很有用。 |
#textSearch |
在文件中查找文本。 |
#todos |
使用待办事项列表跟踪聊天请求的实现和进度。 |
#usages |
“查找所有引用”、“查找实现”和“转到定义”的组合。 |
#VSCodeAPI |
询问有关 VS Code 功能和扩展开发的问题。 |
斜杠命令
斜杠命令是聊天中特定功能的快捷方式。您可以使用它们快速执行操作,例如修复问题、生成测试或解释代码。
| 斜杠命令 | 描述 |
|---|---|
/docs |
从编辑器内联聊天生成代码文档注释。 |
/explain |
解释代码块、文件或编程概念。 |
/fix |
要求 Copilot 修复代码块或解决编译器或 linting 错误。 |
/help |
获取有关在 VS Code 中使用聊天的帮助。 |
/tests |
为编辑器中的所有或仅选定方法和函数生成测试。 |
/setupTests |
获取有关为您的代码设置测试框架的帮助。获取相关测试框架的建议、设置和配置步骤以及 VS Code 测试扩展的建议。 |
/clear |
在聊天视图中开始新的聊天会话。 |
/new |
构建新的 VS Code 工作区或文件。使用自然语言描述您需要的项目/文件类型,并在创建之前预览构建的内容。 |
/newNotebook |
根据您的要求构建新的 Jupyter 笔记本。使用自然语言描述笔记本应包含的内容。 |
/search |
为搜索视图生成搜索查询。使用自然语言描述您要搜索的内容。 |
/startDebugging |
生成 launch.json 调试配置文件并从聊天视图开始调试会话。 |
/<提示文件名> |
在聊天中运行可重用提示文件。 |
聊天参与者
使用聊天参与者处理聊天中的特定领域请求。聊天参与者以 @ 为前缀,可用于询问有关特定主题的问题。VS Code 提供内置聊天参与者,例如 @github、@terminal 和 @vscode,扩展可以提供其他参与者。
| 聊天参与者 | 描述 |
|---|---|
@github |
使用 @github 参与者询问有关 GitHub 存储库、问题、拉取请求等的问题。获取有关可用 GitHub 技能的更多信息。示例: @github 有哪些分配给我的未决 PR?、@github 显示 @dancing-mona 最近合并的 PR |
@terminal |
使用 @terminal 参与者询问有关集成终端或 shell 命令的问题。示例: @terminal 列出此工作区中最大的 5 个文件 |
@vscode |
使用 @vscode 参与者询问有关 VS Code 功能、设置和 VS Code 扩展 API 的问题。示例: @vscode 如何启用自动换行? |
@workspace |
使用 @workspace 参与者询问有关当前工作区的问题。示例: @workspace 身份验证是如何实现的? |
代理模式
通过聊天代理模式,您可以使用自然语言指定一个高级任务,让 AI 自主地推断请求、规划所需工作并将更改应用于您的代码库。代理模式结合使用代码编辑和工具调用来完成您指定的任务。在处理您的请求时,它会监控编辑和工具的结果,并迭代解决出现的任何问题。
| 操作 | 描述 |
|---|---|
| ⇧⌘I (Windows Ctrl+Shift+I, Linux Ctrl+Shift+Alt+I) | 在聊天视图中切换到代理模式 |
| 工具 () | 配置代理模式中可用的工具。从内置工具、MCP 服务器和扩展提供的工具中选择。 |
| 自动批准工具(实验性) | 在代理模式中启用所有工具的自动批准 (chat.tools.autoApprove)。 |
| 自动批准终端命令(实验性) | 在代理模式中启用终端命令的自动批准 (chat.tools.terminal.autoApprove)。 |
| MCP | 配置MCP 服务器以通过额外功能和工具扩展代理模式。 |
提示
- 向代理模式添加额外工具以扩展其功能。
- 配置自定义聊天模式以定义代理模式的运行方式,例如实现只读规划模式。
- 定义自定义指令以指导代理模式如何生成和构造代码。
自定义您的聊天体验
自定义您的聊天体验以生成与您的编码风格、工具和开发人员工作流程匹配的回复。有几种方法可以在 VS Code 中自定义您的聊天体验
-
自定义指令:定义生成代码、执行代码审查或生成提交消息等任务的通用指南或规则。自定义指令描述了 AI 应该操作的条件(如何完成任务)。
-
可重用提示文件:为生成代码或执行代码审查等常见任务定义可重用提示。提示文件是独立的提示,您可以直接在聊天中运行。它们描述了要执行的任务(什么应该完成)。
-
聊天模式:定义聊天如何操作、可以使用哪些工具以及如何与代码库交互。每个聊天提示都在聊天模式的边界内运行,而无需为每个请求配置工具和指令。
提示
- 定义特定于语言的指令,以为每种语言获取更准确的生成代码。
- 将您的指令存储在您的工作区中,以便轻松与您的团队共享。
- 为常见任务定义可重用提示文件,以节省时间并帮助团队成员快速上手。
编辑器 AI 功能
在编辑器中编写代码时,您可以使用 Copilot 在键入时生成代码补全。调用内联聊天以提问并从 Copilot 获得帮助,同时保持在编码流程中。例如,要求 Copilot 为函数或方法生成单元测试。获取有关代码补全和内联聊天的更多信息。
| 操作 | 描述 |
|---|---|
| 代码补全 | 在编辑器中开始键入并获取与您的编码风格匹配并考虑您现有代码的代码建议。 |
| 代码注释 | 通过在代码注释中编写指令来提供代码补全提示。 示例: # 编写一个包含加、减和乘方法的计算器类。使用静态方法。 |
| ⌘I(Windows、Linux Ctrl+I) | 启动编辑器内联聊天以直接从编辑器发送聊天请求。使用自然语言并引用聊天变量和斜杠命令以提供上下文。 |
| F2 | 在代码中重命名符号时获取 AI 驱动的建议。 |
| 上下文菜单操作 | 使用编辑器上下文菜单访问常见的 AI 操作,例如解释代码、生成测试、审查代码等。右键单击编辑器以打开上下文菜单并选择生成代码。 |
| 代码操作 (灯泡) | 选择编辑器中的代码操作 (灯泡) 以修复代码中的 linting 或编译器错误。 |
提示
- 使用有意义的方法或函数名称以更快地获得更好的代码补全。
- 选择代码块以限定您的内联聊天提示范围或通过附加文件或符号来附加相关上下文。
- 使用编辑器上下文菜单选项直接从编辑器访问常见的 AI 驱动操作。
源代码管理和问题
使用 AI 分析您的提交和拉取请求中的更改,并为提交消息和拉取请求描述提供建议。
| 操作 | 描述 |
|---|---|
#changes |
将当前源代码管理更改添加为聊天提示中的上下文。 |
| 提交作为上下文 | 将源代码管理历史记录中的提交添加为聊天提示中的上下文。 |
| 提交消息 | 为源代码管理提交中的当前更改生成提交消息。 |
| 合并冲突 (实验性) | 获取使用 AI 解决 Git 合并冲突的帮助。 |
| 拉取请求描述 | 生成与拉取请求中的更改对应的拉取请求标题和描述。 |
@github |
在聊天中使用 @github 参与者询问有关存储库中的问题、拉取请求等。获取有关可用 GitHub 技能的更多信息。示例: @github 有哪些分配给我的未决 PR?、@github 显示 @dancing-mona 最近合并的 PR |
代码审查 (实验性)
使用 AI 对代码块进行快速审查,或对工作区中未提交的更改进行审查。审查反馈会显示为编辑器中的注释,您可以在其中应用建议。
| 操作 | 描述 |
|---|---|
| 审查选择(预览) | 选择一段代码,然后从编辑器上下文菜单中选择生成代码 > 审查进行快速审查。 |
| 代码审查 | 选择源代码管理视图中的代码审查按钮,对所有未提交的更改进行更深入的审查。 |
搜索和设置
在搜索视图中获取语义相关的搜索结果,或在设置编辑器中帮助搜索设置。
| 操作 | 描述 |
|---|---|
| 设置搜索 | 在设置编辑器中包含语义搜索结果 (workbench.settings.showAISearchToggle)。 |
| 语义搜索(预览) | 在搜索视图中包含语义搜索结果 (search.searchView.semanticSearchBehavior)。 |
生成测试
Copilot 可以为代码库中的函数和方法生成测试。获取有关聊天中的斜杠命令的更多信息。
| 操作 | 描述 |
|---|---|
/tests |
为编辑器中的所有或仅选定的方法和函数生成测试。生成的测试会附加到现有测试文件中,或者创建一个新的测试文件。 |
/setupTests |
获取有关为您的代码设置测试框架的帮助。获取相关测试框架的建议、设置和配置步骤以及 VS Code 测试扩展的建议。 |
/fixTestFailure |
向 Copilot 寻求有关如何修复失败测试的建议。 |
| 测试覆盖率(实验性) | 为尚未被测试覆盖的函数和方法生成测试。获取更多信息。 |
提示
- 提供有关要使用的测试框架或库的详细信息。
调试和修复问题
使用 Copilot 帮助修复编码问题,并帮助配置和启动 VS Code 中的调试会话。
| 操作 | 描述 |
|---|---|
/fix |
向 Copilot 寻求有关如何修复代码块或如何解决代码中任何编译器或 linting 错误的建议。例如,帮助修复未解析的 Node.js 包名称。 |
/fixTestFailure |
向 Copilot 寻求有关如何修复失败测试的建议。 |
/startDebugging (实验性) |
生成 launch.json 调试配置文件并从聊天视图启动调试会话。 |
copilot-debug 命令 |
终端命令可帮助您调试程序。在运行命令前加上前缀以启动其调试会话(例如,copilot-debug python foo.py)。 |
提示
- 提供有关您需要的修复类型的附加信息,例如优化内存消耗或性能。
- 注意编辑器中指示修复代码问题的建议的 Copilot 代码操作。
构建新项目
Copilot 可以通过生成项目结构脚手架或根据您的要求生成笔记本,帮助您创建新项目。
| 操作 | 描述 |
|---|---|
| 代理模式 | 使用代理模式并使用自然语言提示创建新项目或文件。例如,创建一个 Svelte Web 应用程序来跟踪我的任务。 |
/new |
在聊天视图中使用 /new 命令构建新项目或新文件。使用自然语言描述您需要的项目/文件类型,并在创建之前预览构建的内容。示例: /new Express app using typescript and svelte |
/newNotebook |
在聊天视图中使用 /newNotebook 命令根据您的要求生成新的 Jupyter 笔记本。使用自然语言描述笔记本应包含的内容。示例: /newNotebook get census data and preview key insights with Seaborn。 |
终端
获取有关 shell 命令的帮助以及如何在终端中运行命令时解决错误。
| 操作 | 描述 |
|---|---|
| ⌘I(Windows、Linux Ctrl+I) | 启动终端内联聊天以使用自然语言询问有关 shell 命令和终端的问题。 示例: 这台机器有多少个核心? |
@terminal |
在聊天视图中使用 @terminal 参与者询问有关集成终端或 shell 命令的问题。示例: @terminal 列出此工作区中最大的 5 个文件 |
@terminal /explain |
在聊天视图中使用 /explain 命令解释终端中的内容。示例: @terminal /explain top shell command |
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 get census data and preview key insights with Seaborn。 |