在 VS Code 中尝试

用户和工作区设置

你可以通过各种设置将 Visual Studio Code 配置成你喜欢的方式。VS Code 编辑器、用户界面和功能行为的几乎每个部分都有你可以修改的选项。

VS Code 为设置提供了不同的范围:

  • 用户设置 - 适用于你打开的任何 VS Code 实例的全局设置。
  • 工作区设置 - 存储在你的工作区中,并且仅当打开工作区时才应用的设置。

VS Code 将设置值存储在设置 JSON 文件中。你可以通过编辑设置 JSON 文件或使用设置编辑器(提供图形界面来管理设置)来更改设置值。

用户设置

用户设置是你自定义 VS Code 的个人设置。这些设置全局应用于你打开的任何 VS Code 实例。例如,如果你在用户设置中将编辑器字体大小设置为 14,那么在你的计算机上所有 VS Code 实例中,字体大小都将是 14。

你可以通过以下几种方式访问用户设置:

  • 在命令面板中选择首选项:打开用户设置命令(⇧⌘P (Windows、Linux Ctrl+Shift+P)
  • 设置编辑器中选择用户选项卡(⌘, (Windows、Linux Ctrl+,)
  • 在命令面板中选择首选项:打开用户设置 (JSON) 命令(⇧⌘P (Windows、Linux Ctrl+Shift+P)

Settings editor with User tab highlighted

工作区设置

工作区设置特定于某个项目并会覆盖用户设置。如果你希望将特定设置应用于某个特定项目,可以使用工作区设置。例如,对于后端服务器项目,你可能希望设置 files.exclude 以将 node_modules 文件夹从文件浏览器中排除。

注意

VS Code “工作区”通常就是你的项目根文件夹。你还可以通过一项名为多根工作区的功能在 VS Code 工作区中拥有多个根文件夹。获取更多关于VS Code 工作区的信息。

VS Code 将工作区设置存储在项目根目录的 .vscode 文件夹中。这使得在版本控制(例如 Git)项目中轻松与他人共享设置。

你可以通过以下几种方式访问工作区设置:

  • 在命令面板中选择首选项:打开工作区设置命令(⇧⌘P (Windows、Linux Ctrl+Shift+P)
  • 设置编辑器中选择工作区选项卡(⌘, (Windows、Linux Ctrl+,)
  • 在命令面板中选择首选项:打开工作区设置 (JSON) 命令(⇧⌘P (Windows、Linux Ctrl+Shift+P)

Settings editor with Workspace tab highlighted

并非所有用户设置都可用作工作区设置。例如,与更新和安全性相关的应用程序范围设置不能被工作区设置覆盖。

设置编辑器

设置编辑器提供了一个图形界面来管理用户和工作区设置。要打开设置编辑器,请导航到文件 > 首选项 > 设置。或者,通过命令面板⇧⌘P (Windows、Linux Ctrl+Shift+P))打开设置编辑器,使用首选项:打开设置或键盘快捷键(⌘, (Windows、Linux Ctrl+,))。

打开设置编辑器后,你可以搜索并查找所需的设置。当你使用搜索栏进行搜索时,设置编辑器会筛选设置,仅显示符合你条件的设置。这使得查找设置快速简便。

Filtering settings by searching in the Settings editor

VS Code 会在你更改设置时直接应用这些更改。你可以通过设置左侧的彩色条来识别已修改的设置,这与编辑器中修改的行类似。

在下面的示例中,侧边栏位置和文件图标主题已更改。

Modified settings in the Settings editor showing blue vertical bars to the left of them

设置旁边的齿轮图标(⇧F9 (Windows、Linux Shift+F9))会打开一个上下文菜单,其中包含将设置重置为默认值、复制设置 ID、复制 JSON 名称-值对或复制设置 URL 的选项。

Settings edit gear context menu

提示

设置 URL 使你能够从浏览器直接导航到设置编辑器中的特定设置。URL 的格式为 vscode://settings/<settingName>,其中 <settingName> 是你要导航到的设置的 ID。例如,要导航到 workbench.colorTheme 设置,请使用 URL vscode://settings/workbench.colorTheme

设置组

设置以组的形式呈现,以便你可以快速导航到相关设置。顶部有一个“常用”组,其中显示了流行的自定义设置。

在以下示例中,通过在树视图中选择源代码管理,源代码管理设置被聚焦。

Settings editor with the Source Control section of the table of contents selected

注意

VS Code 扩展还可以添加自己的自定义设置,这些设置显示在“扩展”部分下。

设置编辑器筛选器

设置编辑器搜索栏有几个筛选器,可以更轻松地管理你的设置。搜索栏右侧有一个带漏斗图标的筛选按钮,提供选项可以轻松地将筛选器添加到搜索栏。

修改的设置

要检查你配置了哪些设置,搜索栏中有一个 @modified 筛选器。如果设置的值与默认值不同,或者其值在相应的设置 JSON 文件中明确设置,则该设置将显示在此筛选器下。

如果你忘记是否配置了某个设置,或者因为你意外配置了某个设置而导致编辑器行为不如预期,此筛选器会很有用。

Settings editor with @modified filter showing changed settings

其他筛选器

还有其他一些方便的筛选器可以帮助搜索设置。在搜索栏中键入 @ 符号以发现不同的筛选器。

Setting editor @ tag filter dropdown

以下是一些可用筛选器:

  • @ext - 扩展特定的设置。你需要提供扩展 ID,例如 @ext:ms-python.python
  • @feature - 功能子组特定的设置。例如,@feature:explorer 显示文件浏览器的设置。
  • @id - 根据设置 ID 查找设置。例如,@id:workbench.activityBar.visible
  • @lang - 基于语言 ID 应用语言筛选器。例如,@lang:typescript。有关更多详细信息,请参见语言特定编辑器设置
  • @tag - VS Code 系统特定的设置。例如,@tag:workspaceTrust 用于与工作区信任相关的设置,或 @tag:accessibility 用于与辅助功能相关的设置。

搜索栏会记住你的设置搜索查询,并支持撤消/重做(⌘Z (Windows、Linux Ctrl+Z)/⇧⌘Z (Windows、Linux Ctrl+Y))。你可以通过搜索栏右侧的清除设置搜索输入按钮快速清除搜索词或筛选器。

Clear Settings Search Input button in the right of the Settings editor

扩展设置

已安装的 VS Code 扩展还可以贡献自己的设置,你可以在设置编辑器的“扩展”部分下查看这些设置。

C++ extension settings in the Settings editor

你还可以通过扩展视图(⇧⌘X (Windows、Linux Ctrl+Shift+X))选择扩展并查看“功能贡献”选项卡来查看扩展的设置。

Python extension Settings list under Feature Contributions tab

扩展作者可以在配置贡献点文档中了解更多关于添加自定义设置的信息。

设置 JSON 文件

VS Code 将设置值存储在 settings.json 文件中。设置编辑器是允许你查看和修改存储在 settings.json 文件中的设置值的用户界面。

你也可以直接在编辑器中打开 settings.json 文件进行查看和编辑,通过命令面板中的首选项:打开用户设置 (JSON)首选项:打开工作区设置 (JSON) 命令(⇧⌘P (Windows、Linux Ctrl+Shift+P))。

设置通过指定设置 ID 和值以 JSON 形式写入。你可以通过选择设置编辑器中设置的齿轮图标,然后选择复制设置作为 JSON 操作,快速复制设置对应的 JSON 名称-值对。

User settings.json open in the editor

settings.json 文件具有完整的智能感知功能,包括对设置和值的智能补全以及描述悬停。由于不正确的设置名称或 JSON 格式引起的错误也会突出显示。

IntelliSense for settings.json open in the editor

有些设置只能在 settings.json 中编辑,例如工作台:颜色自定义,并在设置编辑器中显示在 settings.json 中编辑链接。

Workbench: Color Customizations setting with Edit in settings.json link

提示

如果你倾向于始终直接使用 settings.json,可以将 workbench.settings.editor 设置为 json。然后,文件 > 首选项 > 设置以及快捷键 ⌘, (Windows、Linux Ctrl+,) 将始终打开 settings.json 文件而不是设置编辑器 UI。

设置文件位置

用户 settings.json 位置

根据你的平台,用户设置文件位于此处:

  • Windows %APPDATA%\Code\User\settings.json
  • macOS $HOME/Library/Application\ Support/Code/User/settings.json
  • Linux $HOME/.config/Code/User/settings.json

工作区 settings.json 位置

工作区设置文件位于根文件夹的 .vscode 文件夹下。当你将工作区设置 settings.json 文件添加到项目或源代码管理中时,项目设置将由该项目的所有用户共享。

The File Explorer displaying settings.json under the .vscode folder

注意

对于多根工作区,工作区设置位于工作区配置文件中。

重置设置

你可以随时将设置重置为默认值,方法是将鼠标悬停在设置上以显示齿轮图标,点击齿轮图标,然后选择重置设置操作。

虽然你可以通过设置编辑器单独重置设置,但你可以通过打开 settings.json 并删除大括号 {} 之间的条目来重置所有已更改的设置。请小心,因为无法恢复以前的设置值。

语言特定编辑器设置

自定义语言特定设置的一种方法是打开设置编辑器,点击筛选按钮,然后选择语言选项以添加语言筛选器。或者,可以直接在搜索小部件中输入 @lang:languageId 形式的语言筛选器。显示的设置将可配置为该特定语言,并且(如果适用)将显示该语言特定的设置值。

当你在有语言筛选器的情况下修改设置时,该设置将在给定范围内为该语言配置。例如,当在搜索小部件中存在 @lang:css 筛选器时修改用户范围的 diffEditor.codeLens 设置时,设置编辑器会将新值保存到用户设置文件中 CSS 特定部分。

Editing the CSS-specific user-scoped diffEditor.codeLens setting in the Settings editor

注意

如果你在搜索小部件中输入多个语言筛选器,则当前行为是只使用第一个语言筛选器。

另一种通过语言自定义编辑器的方法是运行全局命令首选项:配置语言特定设置(命令 ID:workbench.action.configureLanguageBasedSettings),从命令面板⇧⌘P (Windows、Linux Ctrl+Shift+P))中运行,该命令会打开语言选择器。选择你想要的语言。然后,设置编辑器会打开,并带有针对所选语言的语言筛选器,这允许你修改该语言的语言特定设置。但是,如果你的 workbench.settings.editor 设置为 json,那么 settings.json 文件会打开一个新的语言条目,你可以在其中添加适用的设置。

Configure language-specific settings command typed up in the Command Palette

通过下拉菜单选择语言

Select language dropdown

现在你可以开始专门针对该语言编辑设置了

Settings editor showing a specific language filter

或者,如果 workbench.settings.editor 设置为 json,现在你可以开始将语言特定设置添加到用户设置中

Suggestions for language-specific settings shown in the settings JSON file

如果你打开了一个文件,并且想为此文件类型自定义编辑器,请在 VS Code 窗口右下角的“状态栏”中选择“语言模式”。这将打开“语言模式”选择器,其中包含一个选项“配置‘语言名称’语言基于设置”。选择此选项将打开你的用户 settings.json 文件,其中包含语言条目,你可以在其中添加适用的设置。

语言特定编辑器设置始终覆盖非语言特定编辑器设置,即使非语言特定设置的范围更窄。例如,语言特定用户设置会覆盖非语言特定工作区设置。

你可以通过将语言特定设置像其他设置一样放置在工作区设置中,从而将其范围限定为工作区。如果用户和工作区范围都为同一种语言定义了设置,则通过优先使用工作区中定义的设置来合并它们。

以下示例可以粘贴到设置 JSON 文件中,以自定义 typescriptmarkdown 语言模式的编辑器设置。

{
  "[typescript]": {
    "editor.formatOnSave": true,
    "editor.formatOnPaste": true
  },
  "[markdown]": {
    "editor.formatOnSave": true,
    "editor.wordWrap": "on",
    "editor.renderWhitespace": "all",
    "editor.acceptSuggestionOnEnter": "off"
  }
}

你可以在 settings.json 中使用 IntelliSense 来帮助你查找语言特定设置。所有编辑器设置和一些非编辑器设置都受支持。某些语言已预设默认的语言特定设置,你可以通过运行首选项:打开默认设置命令在 defaultSettings.json 中查看这些设置。

多个语言特定编辑器设置

你可以同时为多种语言配置语言特定编辑器设置。以下示例展示了如何在 settings.json 文件中同时为 javascripttypescript 语言自定义设置:

"[javascript][typescript]": {
  "editor.maxTokenizationLineLength": 2500
}

配置文件设置

你可以在 VS Code 中使用配置文件来创建一组自定义设置,并快速在它们之间切换。例如,它们是根据特定编程语言自定义 VS Code 的绝佳方式。

当你切换到某个配置文件时,用户设置仅限于该配置文件。当你切换到另一个配置文件时,将应用该另一个配置文件的用户设置。这样,你可以为不同的配置文件设置不同的设置。

配置文件的用户设置 JSON 文件位于以下目录中:

  • Windows %APPDATA%\Code\User\profiles\<profile ID>\settings.json
  • macOS $HOME/Library/Application\ Support/Code/User/profiles/<profile ID>/settings.json
  • Linux $HOME/.config/Code/User/profiles/<profile ID>/settings.json

<profile ID> 是配置文件的唯一标识符。对于每个覆盖设置的配置文件,都将有一个相应的配置文件设置文件。

注意

配置文件的 settings.json 文件仅在你修改该配置文件的设置时创建。

当你在使用非默认配置文件时,可以通过命令面板中的首选项:打开应用程序设置 (JSON) 命令(⇧⌘P (Windows、Linux Ctrl+Shift+P))访问与默认配置文件关联的 settings.json 文件。

设置优先级

配置可以通过不同的设置范围在多个级别上被覆盖。在以下列表中,后来的范围会覆盖早先的范围

  • 默认设置 - 此范围表示默认未配置的设置值。
  • 用户设置 - 全局应用于所有 VS Code 实例。
  • 远程设置 - 应用于用户打开的远程机器。
  • 工作区设置 - 应用于打开的文件夹或工作区。
  • 工作区文件夹设置 - 应用于多根工作区的特定文件夹。
  • 语言特定默认设置 - 这些是扩展可以贡献的语言特定默认值。
  • 语言特定用户设置 - 与用户设置相同,但特定于某种语言。
  • 语言特定远程设置 - 与远程设置相同,但特定于某种语言。
  • 语言特定工作区设置 - 与工作区设置相同,但特定于某种语言。
  • 语言特定工作区文件夹设置 - 与工作区文件夹设置相同,但特定于某种语言。
  • 策略设置 - 由系统管理员设置,这些值始终会覆盖其他设置值。

设置值可以是各种类型:

  • 字符串 - "files.autoSave": "afterDelay"
  • 布尔值 - "editor.minimap.enabled": true
  • 数字 - "files.autoSaveDelay": 1000
  • 数组 - "editor.rulers": []
  • 对象 - "search.exclude": { "**/node_modules": true, "**/bower_components": true }

原始类型和数组类型的值会被覆盖,这意味着优先级高于其他范围的范围内配置的值会替代其他范围中的值。但是,对象类型的值会被合并。

例如,workbench.colorCustomizations 接受一个对象,该对象指定一组 UI 元素及其所需的颜色。如果你的用户设置将编辑器背景设置为蓝色和绿色:

  "workbench.colorCustomizations": {
    "editor.background": "#000088",
    "editor.selectionBackground": "#008800"
  }

而你打开的工作区设置将编辑器前景设置为红色:

  "workbench.colorCustomizations": {
    "editor.foreground": "#880000",
    "editor.selectionBackground": "#00FF00"
  }

当该工作区打开时,结果是这两个颜色自定义的组合,就好像你指定了:

  "workbench.colorCustomizations": {
    "editor.background": "#000088",
    "editor.selectionBackground": "#00FF00",
    "editor.foreground": "#880000"
  }

如果存在冲突的值,例如上面示例中的 editor.selectionBackground,则会发生通常的覆盖行为,工作区值优先于用户值,语言特定值优先于非语言特定值。

关于多个语言特定设置的注意事项

如果你正在使用多个语言特定设置,请注意语言特定设置会合并,并且优先级是基于完整的语言字符串(例如 "[typescript][javascript]")而不是单独的语言 ID(typescriptjavascript)设置的。这意味着例如,一个 "[typescript][javascript]" 工作区设置不会覆盖一个 "[javascript]" 用户设置。

设置和安全性

某些设置允许你指定 VS Code 将运行的可执行文件来执行某些操作。例如,你可以选择集成终端应使用哪个 shell。为了增强安全性,此类设置只能在用户设置中定义,而不能在工作区范围内定义。

以下是工作区设置中不支持的设置列表:

当你首次打开定义了任何这些设置的工作区时,VS Code 将会警告你,此后将始终忽略这些值。

设置同步

你可以使用设置同步功能在你的 VS Code 实例之间共享用户设置。此功能允许你在不同机器上的 VS Code 安装之间共享设置、键盘快捷方式和已安装的扩展。你可以通过设置编辑器右侧的备份和同步设置命令或账户活动栏上下文菜单启用设置同步。

Turn on Settings Sync command in the Accounts Activity Bar menu

你可以在设置同步用户指南中了解更多关于启用和配置设置同步的信息。

注意

VS Code 不会将你的扩展同步到或从远程窗口,例如当你连接到 SSH、开发容器(devcontainer)或 WSL 时。

功能生命周期

功能及其对应的设置可以处于以下状态之一。根据状态,你在工作流中可能需要谨慎使用该功能或设置。

  • 实验性 - 供早期采用者使用的探索性功能。这些功能将来可能会更改或删除。在设置编辑器中,这些设置带有 Experimental 标签。你也可以通过在搜索框中输入 @tag:experimental 来搜索实验性设置。

    Settings editor filtered with '@tag:experimental' showing experimental settings.

  • 预览 - 预览功能和设置具有最终功能,但仍可能在稳定性和完善方面进行迭代。通常,预览功能默认是禁用的。在设置编辑器中,这些设置带有 Preview 标签。你也可以通过在搜索框中输入 @tag:preview 来搜索预览设置。

    Settings editor filtered with '@tag:preview' showing preview settings.

  • 稳定 - 该功能稳定并在 VS Code 中得到全面支持。

实验性和预览功能使你能够尝试新功能并提供反馈。请在我们的 VS Code 问题中分享你的反馈。

常见问题

VS Code 提示“无法写入设置。”

如果你尝试更改设置(例如开启自动保存或选择新的颜色主题),并看到“无法写入用户设置。请打开用户设置以纠正其中的错误/警告,然后重试。”,这意味着你的 settings.json 文件格式不正确或存在错误。错误可能很简单,例如缺少逗号或设置值不正确。使用命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))中的首选项:打开用户设置 (JSON) 命令打开 settings.json 文件,你应该会看到错误以红色波浪线突出显示。

如何重置我的用户设置?

将 VS Code 重置为默认设置的最简单方法是清除你的用户 settings.json 文件。你可以通过命令面板(⇧⌘P (Windows、Linux Ctrl+Shift+P))中的首选项:打开用户设置 (JSON) 命令打开 settings.json 文件。一旦文件在编辑器中打开,删除两个大括号 {} 之间的所有内容,保存文件,VS Code 将恢复使用默认值。

什么时候使用工作区设置有意义?

当你正在使用一个需要自定义设置但你不想将其应用于其他 VS Code 项目的工作区时。一个很好的例子是语言特定的代码检查规则。

我在哪里可以找到扩展设置?

通常,VS Code 扩展将其设置存储在用户或工作区设置文件中,并且可以通过设置编辑器 UI(首选项:打开设置 (UI) 命令)或通过 settings.json 文件中的智能感知(首选项:打开用户设置 (JSON) 命令)访问。通过扩展名(例如 gitlenspython)搜索可以帮助将设置筛选为仅由扩展贡献的设置。