Visual Studio Code 的键盘快捷方式

Visual Studio Code 允许您直接通过键盘执行大多数任务。本文介绍如何修改 VS Code 自带的默认键盘快捷方式。

键盘快捷方式编辑器

VS Code 通过“键盘快捷方式”编辑器提供了丰富的键盘快捷方式编辑体验。该编辑器列出了所有可用命令（无论有无键盘快捷方式），并允许您使用可用操作来更改、删除或重置它们的键盘快捷方式。要查找命令或键盘快捷方式，请使用搜索框并输入命令或快捷方式来筛选列表。

要打开“键盘快捷方式”编辑器，请选择菜单 文件 > 首选项 > 键盘快捷方式，或在命令面板中使用 首选项：打开键盘快捷方式 命令 (⌘K ⌘S (Windows、Linux 为 Ctrl+K Ctrl+S))。

为 UI 操作自定义快捷方式

要为 UI 操作自定义键盘快捷方式，请在工作台中的任何操作项上右键单击，然后选择 配置键绑定。这会打开“键盘快捷方式”编辑器，并筛选到相应的命令。如果该操作有 when 子句，它也会被自动包含进来，从而让您更轻松地按照自己的需要设置键盘快捷方式。

键盘映射扩展

键盘映射扩展可以修改 VS Code 的快捷方式，使其与其他编辑器的快捷方式相匹配，这样您就不需要学习新的键盘快捷方式了。

选择菜单 文件 > 首选项 > 从...迁移键盘快捷方式，可以获取一个热门键盘映射扩展的列表。在 Marketplace 中也有一个 键盘映射类别 的扩展。

键盘快捷方式参考

我们提供了一个可打印的默认键盘快捷方式版本。选择 帮助 > 键盘快捷方式参考，可以显示一个简明的 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) 按钮。

  

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

键盘规则

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 中使用当前系统的键盘布局进行渲染。例如，在使用法语（法国）键盘布局时，拆分编辑器 现在被渲染为 Ctrl+*。

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

还有一个 UI 控件可以帮助在编辑 keybindings.json 时输入键盘快捷方式规则。要启动 定义键绑定 控件，请按 ⌘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 中可见和活动的元素，设置各种上下文键和特定值。例如，内置的 开始调试 命令的键盘快捷方式是 F5，它仅在有合适的调试器可用（上下文 debuggersAvailable 为 true）且编辑器不处于调试模式（上下文 inDebugMode 为 false）时才启用。

您也可以在默认的 keybindings.json (首选项：打开默认键盘快捷方式 (JSON)) 中直接查看键盘快捷方式的 when 子句。

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

条件运算符

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

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

可用的上下文

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

该列表并不详尽，您可以通过在“键盘快捷方式”编辑器 (首选项：打开键盘快捷方式) 中搜索和筛选，或查看默认的 keybindings.json 文件 (首选项：打开默认键盘快捷方式 (JSON)) 来查找其他 when 子句上下文。

为重构自定义键盘快捷方式

editor.action.codeAction 命令允许您为特定的重构（代码操作）配置键盘快捷方式。例如，下面的键盘快捷方式会触发 提取函数 重构代码操作：

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

这在重构文章中有深入介绍，您可以在其中了解不同类型的代码操作，以及在有多种可能的重构时如何确定它们的优先级。

相关资源

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

常见问题

我如何找出哪个命令绑定到了特定的键？

在“键盘快捷方式”编辑器中，您可以按特定的按键组合进行筛选，以查看哪些命令绑定到了哪些键。在下面的截图中，您可以看到 Ctrl+Shift+P 绑定到了 显示所有命令，以调出命令面板。

如何为一个操作添加键盘快捷方式，例如，为“删除行”添加 Ctrl+D？

在 默认键盘快捷方式 中找到触发该操作的规则，并在您的 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。不幸的是，在这一点上，这是一个反复试验的过程。