参加你附近的 ,了解 VS Code 中的 AI 辅助开发。

IntelliSense

IntelliSense 是一个通用术语,指代各种代码编辑功能,包括:代码补全、参数信息、快速信息和成员列表。IntelliSense 功能有时也被称为“代码完成”、“内容辅助”和“代码提示”。

为你的编程语言提供 IntelliSense

Visual Studio Code 为 JavaScript、TypeScript、JSON、HTML、CSS、SCSS 和 Less 提供了开箱即用的 IntelliSense。VS Code 支持对任何编程语言进行基于单词的补全,但也可以通过安装语言扩展来配置更丰富的 IntelliSense。

以下是 Visual Studio Marketplace 中最受欢迎的语言扩展。选择下方的扩展磁贴,阅读其描述和评论,以决定哪个扩展最适合你。

IntelliSense 功能

VS Code 的 IntelliSense 功能由语言服务提供支持。语言服务基于语言语义和对源代码的分析,提供智能的代码补全。如果语言服务知道可能的补全项,IntelliSense 建议将在你输入时弹出。如果你继续输入字符,成员列表(变量、方法等)将被过滤,只包含包含你所输入字符的成员。按下 TabEnter 键将插入所选的成员。

你可以在任何编辑器窗口中通过输入 ⌃Space (Windows, Linux Ctrl+Space) 或输入触发字符(例如 JavaScript 中的点字符 (.))来触发 IntelliSense。

提示

建议控件支持驼峰式(CamelCase)过滤,这意味着你可以输入方法名中的大写字母来限制建议。例如,输入 "cra" 会带出 "createApplication"。

如果你愿意,可以在输入时关闭 IntelliSense。请参阅自定义 IntelliSense,了解如何禁用或自定义 VS Code 的 IntelliSense 功能。

通过语言服务提供的功能,你可以通过按下 ⌃Space (Windows, Linux Ctrl+Space) 或选择 > 图标来查看每个方法的快速信息。该方法附带的文档会在侧边展开。展开的文档会保持显示,并在你浏览列表时更新。你可以通过再次按下 ⌃Space (Windows, Linux Ctrl+Space) 或选择关闭图标来关闭它。

选择一个方法后,你将获得参数信息

parameter info

在适用的情况下,语言服务会在快速信息和方法签名中显示底层类型。在上一张截图中,你可以看到几个 any 类型。因为 JavaScript 是动态的,不需要或不强制执行类型,所以 any 表示该变量可以是任何类型。

补全的类型

以下截图中的 JavaScript 代码展示了 IntelliSense 的补全功能。IntelliSense 既提供推断出的建议,也提供项目的全局标识符。推断出的符号会首先显示,然后是全局标识符(由 abc 单词图标表示)。

intellisense icons

VS Code IntelliSense 提供不同类型的补全,包括语言服务器建议、代码片段和简单的基于单词的文本补全。

图标 名称 符号类型
方法和函数 methodfunctionconstructor
变量 variable
字段 field
类型参数 typeParameter
常量 constant
class
接口 interface
结构体 struct
事件 event
运算符 operator
模块 module
属性和特性 property
枚举 enum
枚举成员 enumMember
参考 reference
关键字 keyword
文件 file
文件夹 folder
颜色 color
单位 unit
代码片段前缀 snippet
单词 text

自定义 IntelliSense

你可以在设置和键盘快捷方式中自定义你的 IntelliSense 体验。

设置

下面显示的是默认设置。你可以在设置编辑器⌘, (Windows, Linux Ctrl+,))中更改这些设置。

{
    // Controls if quick suggestions should show up while typing
    "editor.quickSuggestions": {
        "other": true,
        "comments": false,
        "strings": false
    },

     // Controls whether suggestions should be accepted on commit characters. For example, in JavaScript, the semi-colon (`;`) can be a commit character that accepts a suggestion and types that character.
    "editor.acceptSuggestionOnCommitCharacter": true,

    // Controls if suggestions should be accepted on 'Enter' - in addition to 'Tab'. Helps to avoid ambiguity between inserting new lines or accepting suggestions. The value 'smart' means only accept a suggestion with Enter when it makes a textual change
    "editor.acceptSuggestionOnEnter": "on",

    // Controls the delay in ms after which quick suggestions will show up.
    "editor.quickSuggestionsDelay": 10,

    // Controls if suggestions should automatically show up when typing trigger characters
    "editor.suggestOnTriggerCharacters": true,

    // Controls if pressing tab inserts the best suggestion and if tab cycles through other suggestions
    "editor.tabCompletion": "off",

    // Controls whether sorting favours words that appear close to the cursor
    "editor.suggest.localityBonus": true,

    // Controls how suggestions are pre-selected when showing the suggest list
    "editor.suggestSelection": "first",

    // Enable word based suggestions
    "editor.wordBasedSuggestions": "matchingDocuments",

    // Enable parameter hints
    "editor.parameterHints.enabled": true,
}

Tab 补全

编辑器支持Tab 补全,即在按下 Tab 键时插入最佳匹配的补全项。无论建议控件是否显示,这都有效。此外,在插入一个建议后按下 Tab 键会插入下一个最佳建议。

默认情况下,Tab 补全是禁用的。使用 editor.tabCompletion 设置来启用它。存在以下值:

  • off - (默认) Tab 补全被禁用。
  • on - Tab 补全对所有建议都启用,并且重复调用会插入下一个最佳建议。
  • onlySnippets - Tab 补全仅插入与当前行前缀匹配的静态代码片段。

邻近度加成

建议的排序取决于扩展信息以及它们与你当前正在输入的单词的匹配程度。此外,你可以使用 editor.suggest.localityBonus 设置,要求编辑器提升那些出现在光标位置附近的建议的排序。

Sorted By Locality

在上一张截图中,你可以看到 countcontextcolocated 是根据它们出现的范围(循环、函数、文件)进行排序的。

建议选择

默认情况下,VS Code 会预选建议列表中的第一个建议。如果你想要不同的行为,例如,总是选择建议列表中最近使用的项,你可以使用 editor.suggestSelection 设置。

可用的 editor.suggestSelection 值有:

  • first - (默认) 总是选择列表顶部的项。
  • recentlyUsed - 除非前缀(通过输入来选择)选择了不同的项,否则将选择之前使用过的项。
  • recentlyUsedByPrefix - 根据之前完成这些建议的前缀来选择项。

选择最近使用的项非常有用,因为你可以快速地多次插入相同的补全。

“通过输入来选择”意味着当前的前缀(大致是光标左侧的文本)被用来过滤和排序建议。当这种情况发生,并且其结果与 recentlyUsed 的结果不同时,它将被优先考虑。

当使用最后一个选项 recentlyUsedByPrefix 时,VS Code 会记住针对特定前缀(部分文本)选择了哪个项。例如,如果你输入了 co 然后选择了 console,下次你输入 co 时,建议 console 将被预选。这让你能够快速地将各种前缀映射到不同的建议,例如 co -> consolecon -> const

建议中的代码片段

默认情况下,VS Code 在一个控件中显示代码片段和补全建议。你可以使用 editor.snippetSuggestions 设置来修改此行为。要从建议控件中移除代码片段,请将该值设置为 "none"。如果你想看到代码片段,你可以指定它们相对于建议的顺序;在顶部("top")、在底部("bottom")或按字母顺序内联排序("inline")。默认值是 "inline"

键盘快捷键

此处显示的键盘快捷方式是默认的键盘快捷方式。要分配不同的键盘快捷方式,请使用键盘快捷方式编辑器⌘K ⌘S (Windows, Linux Ctrl+K Ctrl+S))。

命令 按键绑定
editor.action.triggerSuggest ⌃Space (Windows, Linux Ctrl+Space)
toggleSuggestionDetails ⌃Space (Windows, Linux Ctrl+Space)
toggleSuggestionFocus ⌃⌥Space (Windows, Linux Ctrl+Alt+Space)
提示

还有许多与 IntelliSense 相关的键盘快捷方式。打开默认键盘快捷方式文件 > 首选项 > 键盘快捷方式)并搜索 "suggest"。

使用 AI 增强补全

GitHub Copilot 在你编辑器中输入时提供编码建议。你还可以向 Copilot 提出与编码相关的问题,例如如何最好地编写代码、如何修复错误或别人的代码是如何工作的。

开始使用

  1. 安装 GitHub Copilot 扩展

  2. 通过我们的Copilot 快速入门来探索其关键功能。

提示

如果你还没有 Copilot 订阅,可以通过注册 Copilot 免费计划来免费使用 Copilot,并获得每月限量的补全和聊天交互。

故障排除

如果你发现 IntelliSense 停止工作,可能是语言服务没有运行。尝试重启 VS Code,这应该能解决问题。如果在安装语言扩展后仍然缺少 IntelliSense 功能,请在该语言扩展的仓库中提出一个 issue。

提示

有关配置和排查 JavaScript IntelliSense 的问题,请参阅 JavaScript 文档

特定的语言扩展可能不支持所有的 VS Code IntelliSense 功能。请查看扩展的 README 文件以了解支持哪些功能。如果你认为某个语言扩展存在问题,通常可以通过 VS Code Marketplace 找到该扩展的 issue 仓库。导航到扩展的详细信息页面,并选择支持链接。

后续步骤

IntelliSense 只是 VS Code 强大功能之一。继续阅读以了解更多信息:

常见问题

为什么我收不到任何建议?

这可能由多种原因引起。首先,尝试重启 VS Code。如果问题仍然存在,请查阅语言扩展的文档。对于 JavaScript 特定的故障排除,请参阅 JavaScript 语言主题

为什么我看不到方法和变量的建议?

image of IntelliSense showing no useful suggestions

这个问题是由 JavaScript 中缺少类型声明(typings)文件引起的。大多数常见的 JavaScript 库都附带了声明文件或有可用的类型声明文件。

请确保为你正在使用的库安装了相应的 npm 或 yarn 包。在使用 JavaScript 文章中了解更多关于 IntelliSense 的信息。对于其他语言,请查阅扩展的文档。