Visual Studio Code 键盘快捷键

Visual Studio Code 允许您通过键盘直接执行大多数任务。本文档解释了如何修改 VS Code 附带的默认键盘快捷键。

键盘快捷方式编辑器

VS Code 提供了一个丰富的键盘快捷键编辑体验，通过键盘快捷键编辑器实现。该编辑器列出了所有可用的命令，无论是否有键盘快捷键，并允许您使用可用的操作来更改、删除或重置它们的键盘快捷键。要查找命令或键盘快捷键，请使用搜索框输入命令或快捷键以过滤列表。

要打开键盘快捷键编辑器，请选择 文件 > 首选项 > 键盘快捷键 菜单，或使用 首选项：打开键盘快捷键 命令 (⌘K ⌘S (Windows, Linux Ctrl+K Ctrl+S)) 在命令面板中。键盘快捷键编辑器默认以 模态叠加层 形式在编辑器区域上方打开。

自定义用户界面操作的快捷键

要自定义用户界面操作的键盘快捷键，请右键单击工作台中的任何操作项，然后选择 配置键绑定。这将打开键盘快捷键编辑器，并过滤到相应的命令。如果该操作具有 when 子句，则会自动包含该子句，从而更轻松地设置您需要的键盘快捷键。

键盘映射扩展

键盘映射扩展会修改 VS Code 的快捷键，以匹配其他编辑器的快捷键，因此您无需学习新的键盘快捷键。

选择 文件 > 首选项 > 从...迁移键盘快捷键 菜单，以获取流行的键盘映射扩展列表。市场中还有一个 键盘映射类别 的扩展。

键盘快捷键参考

我们提供了默认键盘快捷键的可打印版本。选择 帮助 > 键盘快捷键参考 以显示一个精简的 PDF 版本，适合于打印作为易于使用的参考。

以下链接提供对三个特定平台版本（美国英语键盘）的访问权限

• Windows
• macOS
• Linux

检测键盘快捷键冲突

如果您安装了许多扩展程序或修改了键盘快捷键，可能会出现键盘快捷键冲突，即相同的键盘快捷键映射到多个命令。这可能会导致令人困惑的行为，尤其是在您在编辑器中移动时，不同的键盘快捷键会进出作用域。

右键单击键盘快捷键列表中的一个项目，然后选择 显示相同的键绑定 以查看具有相同键盘快捷键的所有条目。

解决键盘快捷键问题

要解决键盘快捷键问题，您可以执行 开发人员：切换键盘快捷键故障排除 命令。这将激活已分派键盘快捷键的日志记录，并在输出面板中打开相应的日志文件。

然后，您可以按下所需的键盘快捷键，并检查 VS Code 检测到的键盘快捷键以及调用的命令。

例如，在 macOS 上，在代码编辑器中按下 cmd+/ 时，日志输出将是

[KeybindingService]: / Received  keydown event - modifiers: [meta], code: MetaLeft, keyCode: 91, key: Meta
[KeybindingService]: | Converted keydown event - modifiers: [meta], code: MetaLeft, keyCode: 57 ('Meta')
[KeybindingService]: \ Keyboard event cannot be dispatched.
[KeybindingService]: / Received  keydown event - modifiers: [meta], code: Slash, keyCode: 191, key: /
[KeybindingService]: | Converted keydown event - modifiers: [meta], code: Slash, keyCode: 85 ('/')
[KeybindingService]: | Resolving meta+[Slash]
[KeybindingService]: \ From 2 keybinding entries, matched editor.action.commentLine, when: editorTextFocus && !editorReadonly, source: built-in.

在示例日志中，第一个 keydown 事件是针对 MetaLeft 键 (cmd) 的，无法分派。第二个 keydown 事件是针对 Slash 键 (/) 的，并被分派为 meta+[Slash]。有两项键盘快捷键条目映射自 meta+[Slash]，匹配的是命令 editor.action.commentLine，该命令具有 when 条件 editorTextFocus && !editorReadonly 并且是一个内置的键盘快捷键条目。

查看修改过的键盘快捷键

要仅显示您已修改的快捷键，请选择 更多操作 (...) 菜单中的 显示用户键绑定 命令。这将向 键盘快捷键 编辑器应用 @source:user 过滤器（来源为“用户”）。

高级自定义

VS Code 会跟踪您在 keybindings.json 文件中自定义的键盘快捷键。对于高级自定义，您还可以直接修改 keybindings.json 文件。

要打开 keybindings.json 文件

• 打开 键盘快捷键 编辑器，然后选择编辑器标题栏右侧的 打开键盘快捷键 (JSON) 按钮。

  

• 或者，使用命令面板中的 打开默认键盘快捷键 (JSON) 命令 (⇧⌘P (Windows, Linux Ctrl+Shift+P))。

键盘规则

VS Code 中的键盘快捷键配置也称为键盘规则。每个规则包含以下属性

• key：描述按下的键，例如 ⌘F (Windows, Linux Ctrl+F)。
• command：要执行的 VS Code 命令的标识符，例如 workbench.view.explorer 以打开资源管理器视图。
• when：(可选) 子句，包含一个布尔表达式，该表达式根据当前的 上下文 进行评估。

和弦（两个单独的按键操作）通过空格分隔两个按键操作来描述。例如，Ctrl+K Ctrl+C。

按下键时，将应用以下评估规则

• 规则从 底部 到 顶部 进行评估。
• 第一个同时匹配 key 和 when 子句的规则将被接受。
• 如果找到一个规则，则不再处理更多规则。
• 如果找到一个规则并且设置了 command，则将执行该 command。

额外的 keybindings.json 规则将在运行时附加到默认规则的底部，从而允许它们覆盖默认规则。VS Code 会监视 keybindings.json 文件，因此在 VS Code 运行时编辑它将更新运行时规则。

键盘快捷键分派是通过分析用 JSON 表达的规则列表来完成的。以下是一些示例

// Keyboard shortcuts that are active when the focus is in the editor
{ "key": "home",            "command": "cursorHome",                  "when": "editorTextFocus" },
{ "key": "shift+home",      "command": "cursorHomeSelect",            "when": "editorTextFocus" },

// Keyboard shortcuts that are complementary
{ "key": "f5",              "command": "workbench.action.debug.continue", "when": "inDebugMode" },
{ "key": "f5",              "command": "workbench.action.debug.start",    "when": "!inDebugMode" },

// Global keyboard shortcuts
{ "key": "ctrl+f",          "command": "actions.find" },
{ "key": "alt+left",        "command": "workbench.action.navigateBack" },
{ "key": "alt+right",       "command": "workbench.action.navigateForward" },

// Global keyboard shortcuts using chords (two separate keypress actions)
{ "key": "ctrl+k enter",    "command": "workbench.action.keepEditor" },
{ "key": "ctrl+k ctrl+w",   "command": "workbench.action.closeAllEditors" },

允许的按键

key 由修饰符和键本身组成。

接受以下修饰符

接受以下按键

• f1-f19, a-z, 0-9
• `, -, =, [, ], \, ;, ', ,, ., /
• left, up, right, down, pageup, pagedown, end, home
• tab, enter, escape, space, backspace, delete
• pausebreak, capslock, insert
• numpad0-numpad9, numpad_multiply, numpad_add, numpad_separator
• numpad_subtract, numpad_decimal, numpad_divide

命令参数

您可以将参数传递给命令。如果经常对特定文件或文件夹执行相同的操作，这将很有用。您可以添加自定义键盘快捷键来执行您想要的操作。

以下是一个覆盖 Enter 键以打印一些文本的示例

{
  "key": "enter",
  "command": "type",
  "args": { "text": "Hello World" },
  "when": "editorTextFocus"
}

type 命令将接收 {"text": "Hello World"} 作为它的第一个参数，并将“Hello World”添加到文件中，而不是生成默认命令。

有关接受参数的命令的更多信息，请参阅 内置命令。

运行多个命令

可以通过使用 runCommands 命令来配置键盘快捷键以按顺序运行多个命令。

• 运行几个没有参数的命令

  以下示例将当前行向下复制，将当前行标记为注释，并将光标移动到复制的行。

  {
    "key": "ctrl+alt+c",
    "command": "runCommands",
    "args": {
      "commands": [
        "editor.action.copyLinesDownAction",
        "cursorUp",
        "editor.action.addCommentLine",
        "cursorDown"
      ]
    }
  },
  

• 要将参数传递给命令

  此示例创建一个新的无标题 TypeScript 文件并插入一个自定义代码片段。

  {
    "key": "ctrl+n",
    "command": "runCommands",
    "args": {
      "commands": [
        {
          "command": "workbench.action.files.newUntitledFile",
          "args": {
            "languageId": "typescript"
          }
        },
        {
          "command": "editor.action.insertSnippet",
          "args": {
            "langId": "typescript",
            "snippet": "class ${1:ClassName} {\n\tconstructor() {\n\t\t$0\n\t}\n}"
          }
        }
      ]
    }
  },
  

请注意，由 runCommands 运行的命令接收 "args" 的值作为第一个参数。在前面的示例中，workbench.action.files.newUntitledFile 接收 {"languageId": "typescript" } 作为它的第一个也是唯一的参数。

要传递多个参数，您需要将 "args" 作为数组

{
  "key": "ctrl+shift+e",
  "command": "runCommands",
  "args": {
    "commands": [
      {
        // command invoked with 2 arguments: vscode.executeCommand("myCommand", "arg1", "arg2")
        "command": "myCommand",
        "args": ["arg1", "arg2"]
      }
    ]
  }
}

要传递数组作为第一个参数，请将数组包装在另一个数组中："args": [ [1, 2, 3] ]。

删除键盘快捷键

要删除键盘快捷键，请右键单击键盘快捷键编辑器中的条目，然后选择 删除键绑定。

要通过 keybindings.json 文件删除键盘快捷键，请将 - 添加到 command 中，该规则将成为删除规则。

这是一个例子

// In Default Keyboard Shortcuts
...
{ "key": "tab", "command": "tab", "when": ... },
{ "key": "tab", "command": "jumpToNextSnippetPlaceholder", "when": ... },
{ "key": "tab", "command": "acceptSelectedSuggestion", "when": ... },
...

// To remove the second rule, for example, add in keybindings.json:
{ "key": "tab", "command": "-jumpToNextSnippetPlaceholder" }

要使用空操作覆盖特定的键盘快捷键规则，您可以指定一个空命令

// To override and disable any `tab` keyboard shortcut, for example, add in keybindings.json:
{ "key": "tab", "command": "" }

键盘布局

按键是虚拟键的字符串表示形式，不一定与按下时产生的字符相关。更准确地说

• 参考：虚拟键码 (Windows)
• tab 代表 VK_TAB (0x09)
• ; 代表 VK_OEM_1 (0xBA)
• = 用于 VK_OEM_PLUS (0xBB)
• , 用于 VK_OEM_COMMA (0xBC)
• - 用于 VK_OEM_MINUS (0xBD)
• . 用于 VK_OEM_PERIOD (0xBE)
• / 用于 VK_OEM_2 (0xBF)
• ` 用于 VK_OEM_3 (0xC0)
• [ 用于 VK_OEM_4 (0xDB)
• \ 用于 VK_OEM_5 (0xDC)
• ] 用于 VK_OEM_6 (0xDD)
• ' 用于 VK_OEM_7 (0xDE)
• 等等。

不同的键盘布局通常会重新定位这些虚拟键，或者更改按下它们时产生的字符。在使用非标准美国键盘布局时，Visual Studio Code 会执行以下操作：

所有键盘快捷键都在 UI 中使用当前系统的键盘布局呈现。例如，使用法语（法国）键盘布局时，Split Editor 现在呈现为 Ctrl+*

在编辑 keybindings.json 时，VS Code 会突出显示具有误导性的键盘快捷键，这些快捷键在文件中使用标准美国键盘布局产生的字符表示，但需要在当前系统的键盘布局下按下带有不同标签的键。例如，以下是使用法语（法国）键盘布局时默认键盘快捷键规则的外观：

还有一个 UI 控制项，可在编辑 keybindings.json 时帮助输入键盘快捷键规则。要启动“Define Keybinding”控制项，请按 ⌘K ⌘K (Windows, Linux Ctrl+K Ctrl+K)。该控制项会监听按键，并在文本框中以及下方呈现序列化的 JSON 表示形式，以及 VS Code 在您当前的键盘布局下检测到的键。键入所需的键组合后，可以按 Enter，然后插入规则片段。

与键盘布局无关的绑定

使用扫描码，可以定义键盘快捷键，这些快捷键不会随键盘布局的更改而更改。例如：

{ "key": "cmd+[Slash]", "command": "editor.action.commentLine", "when": "editorTextFocus" }

接受的扫描码

• [F1]-[F19]、[KeyA]-[KeyZ]、[Digit0]-[Digit9]
• [Backquote]、[Minus]、[Equal]、[BracketLeft]、[BracketRight]、[Backslash]、[Semicolon]、[Quote]、[Comma]、[Period]、[Slash]
• [ArrowLeft]、[ArrowUp]、[ArrowRight]、[ArrowDown]、[PageUp]、[PageDown]、[End]、[Home]
• [Tab]、[Enter]、[Escape]、[Space]、[Backspace]、[Delete]
• [Pause]、[CapsLock]、[Insert]
• [Numpad0]-[Numpad9]、[NumpadMultiply]、[NumpadAdd]、[NumpadComma]
• [NumpadSubtract]、[NumpadDecimal]、[NumpadDivide]

when 子句上下文

VS Code 通过可选的 when 子句为您提供了对键盘快捷键何时启用的精确控制。如果您的键盘快捷键没有 when 子句，则该键盘快捷键始终全局可用。when 子句的结果为 true 或 false，用于启用键盘快捷键。

VS Code 会根据 VS Code UI 中可见和活动的内容设置各种上下文键和特定值。例如，内置的“Start Debugging”命令具有键盘快捷键 F5，该快捷键仅在有合适的调试器可用（上下文 debuggersAvailable 为 true）且编辑器不在调试模式下（上下文 inDebugMode 为 false）时启用。

您还可以直接在默认的 keybinding.json 中查看键盘快捷键的 when 子句（Preferences: Open Default Keyboard Shortcuts (JSON)）。

{ "key": "f5",  "command": "workbench.action.debug.start",
                   "when": "debuggersAvailable && !inDebugMode" },

条件运算符

对于 when 子句条件表达式，以下条件运算符对键盘快捷键很有用：

您可以在 when 子句上下文 参考中找到完整的 when 子句条件运算符列表。

可用上下文

您可以在 when 子句上下文参考 中找到一些可用的 when 子句上下文。

那里的列表并不详尽，您可以通过在键盘快捷键编辑器（Preferences: Open Keyboard Shortcuts）中搜索和筛选，或查看默认的 keybindings.json 文件（Preferences: Open Default Keyboard Shortcuts (JSON)）来找到其他 when 子句上下文。

针对重构的自定义键盘快捷键

editor.action.codeAction 命令允许您为特定的 重构（代码操作）配置键盘快捷键。例如，以下键盘快捷键触发“Extract function”重构代码操作：

{
  "key": "ctrl+shift+r ctrl+e",
  "command": "editor.action.codeAction",
  "args": {
    "kind": "refactor.extract.function"
  }
}

这在 重构 文章中有深入介绍，您可以在其中了解不同类型的代码操作以及如何在出现多种可能的重构时对其进行优先级排序。

相关资源

• VS Code 默认键盘快捷键参考

常见问题

如何确定绑定到特定键的命令？

在键盘快捷键编辑器中，您可以按特定按键进行筛选，以查看哪些命令绑定到哪些按键。在以下屏幕截图中，您可以看到 Ctrl+Shift+P 绑定到“Show All Commands”，以调出命令面板。

如何将键盘快捷键添加到操作，例如，将 Ctrl+D 添加到 Delete Lines？

在“Default Keyboard Shortcuts”中找到触发该操作的规则，并在您的 keybindings.json 文件中编写其修改版本。

// Original, in Default Keyboard Shortcuts
{ "key": "ctrl+shift+k",          "command": "editor.action.deleteLines",
                                     "when": "editorTextFocus" },
// Modified, in User/keybindings.json, Ctrl+D now will also trigger this action
{ "key": "ctrl+d",                "command": "editor.action.deleteLines",
                                     "when": "editorTextFocus" },

如何仅为某些文件类型添加键盘快捷键？

在您的 when 子句中使用 editorLangId 上下文键。

{ "key": "shift+alt+a",           "command": "editor.action.blockComment",
                                     "when": "editorTextFocus && editorLangId == csharp" },

我修改了 keybindings.json 中的键盘快捷键；为什么它们不起作用？

最常见的问题是文件中的语法错误。否则，请尝试删除 when 子句或选择不同的 key。不幸的是，到目前为止，这是一个反复试验的过程。