Getting code suggestions in your IDE with GitHub Copilot

About GitHub Copilot and Visual Studio Code

This guide demonstrates how to get coding suggestions from GitHub Copilot in Visual Studio Code. To see instructions for other popular coding environments, use the tool switcher at the top of the page.

Copilot in VS Code provides two kinds of suggestions:

• Code completion. Copilot offers coding suggestions as you type. You can also describe something you want to do using natural language within a comment, and Copilot will suggest the code to accomplish your goal.
• 下一个编辑建议 (公共预览版). Based on the edits you are making, Copilot will predict the location of the next edit you are likely to make and suggest a completion for it.

The examples in this guide use JavaScript, however other languages will work similarly. GitHub Copilot 为多种语言和各种框架提供建议，但尤其适用于 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++。 GitHub Copilot 还可以帮助生成数据库的查询，生成 API 和框架的建议，并可以帮助开发基础结构即代码。

Prerequisites

• Access to Copilot. To use GitHub Copilot in Visual Studio Code, you need either limited access through Copilot 免费版 or a paid Copilot plan for full access. 有关如何访问 Copilot 的信息，请参阅“What is GitHub Copilot?”。

• Sign in to GitHub in Visual Studio Code. See Set up GitHub Copilot in Visual Studio Code in the VS Code documentation..

• Visual Studio Code. To use GitHub Copilot in Visual Studio Code, you must have Visual Studio Code installed. For more information, see the Visual Studio Code download page.

• Copilot in Visual Studio Code. When you set up GitHub Copilot in Visual Studio Code for the first time, the required extensions are installed automatically. You don't need to download or install them manually. For detailed instructions, see Set up GitHub Copilot in Visual Studio Code in the Visual Studio Code documentation.

Getting code suggestions

GitHub Copilot offers coding suggestions as you type. For example, type this function header in a JavaScript file:

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot will automatically suggest the rest of the function. 要接受建议，请按 Tab。

You can also describe something you want to do using natural language within a comment, and Copilot will suggest the code to accomplish your goal. For example, type this comment in a JavaScript file:

// write a function to
// find all images without alternate text
// and give them a red border

// write a function to
// find all images without alternate text
// and give them a red border

GitHub Copilot will automatically suggest code. 要接受建议，请按 Tab。

Showing alternative suggestions

对于任何给定的输入，GitHub Copilot 可以提供多个建议。 可以选择要使用的建议，或拒绝所有建议。

For example, type this function header in a JavaScript file, and press Enter:

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot will show you a suggestion.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To display next or previous suggestions, click the forward or back arrow button in the control.

You can also use keyboard shortcuts to show alternative suggestions:

要接受建议，请单击 Copilot 命令面板中的“接受”，或按 Tab。要拒绝所有建议，请按 Esc。

Showing multiple suggestions in a new tab

如果不想使用 GitHub Copilot 提供的任何初始建议，可以在新选项卡中显示多个建议。

For example, type this function header in a JavaScript file, and press Enter:

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot will show you a suggestion. Now press Ctrl+Enter to open a new tab with multiple additional options.

To accept a suggestion, below the suggestion, click Accept suggestion NUMBER. To reject all suggestions, close the tab.

Accepting partial suggestions

If you don't want to accept an entire suggestion from GitHub Copilot, you can accept the next word or the next line of a suggestion.

For example, type this function header in a JavaScript file, and press Enter:

function calculateDaysBetweenDates(begin, end) {

function calculateDaysBetweenDates(begin, end) {

GitHub Copilot will automatically suggest an entire function body in grayed text. The exact suggestion may vary.

Now hover over the suggestion to show the GitHub Copilot control for choosing suggestions. To accept only the next word of the suggestion, click Accept Word in the control.

Alternatively, you can use a keyboard shortcut to accept the next word of a suggestion:

If you want to accept the next line of a suggestion, you will need to set a custom keyboard shortcut for the command editor.action.inlineSuggest.acceptNextLine. For more information on setting custom keyboard shortcuts, see Configuring GitHub Copilot in your environment.

About 下一个编辑建议

Inline suggestions autocomplete code, but many development tasks involve editing existing code. 下一个编辑建议 assists with edits both at the cursor and in other relevant parts of the code, helping maintain consistency and streamline changes.

下一个编辑建议 predicts where and what edits may be needed based on ongoing changes. Suggestions may span a single symbol, an entire line, or multiple lines, depending on the scope of the potential change.

To enable 下一个编辑建议, see Configuring GitHub Copilot in your environment.

Navigating and accepting suggestions

You can navigate suggested code changes using Tab, making it easier to find the next relevant edit without manually searching through files or references. Press Tab again to accept a suggestion.

An arrow in the gutter indicates an available edit suggestion. Hover over the arrow to access the edit suggestion menu, which provides keyboard shortcuts and settings options. If an edit suggestion is outside the current editor view, the arrow will point up or down to indicate where the next suggestion is.

For more details and examples, see Code completions with GitHub Copilot in VS Code in the Visual Studio Code documentation.

Changing the AI model

You can change the large language model that's used to generate code completion suggestions. For more information, see Changing the AI model for Copilot code completion.