现已发布！阅读关于 12 月份的新功能和修复。

Visual Studio Code 中的代码片段

代码片段是用于更轻松地输入重复代码模式（如循环或条件语句）的模板。

在 Visual Studio Code 中，代码片段会与其他建议一起出现在 IntelliSense（⌃Space (Windows、Linux Ctrl+Space)）中，并且还可以通过专用的代码片段选取器（命令面板中的“插入代码片段”）进行访问。还支持制表符补全：使用 "editor.tabCompletion": "on" 启用它，输入**代码片段前缀**（触发文本），然后按 Tab 插入代码片段。

代码片段语法遵循 TextMate 代码片段语法，但“插值 shell 代码”和 \u 的使用除外；这两者均不受支持。

ajax snippet

内置代码片段

VS Code 为 JavaScript、TypeScript、Markdown 和 PHP 等多种语言内置了代码片段。

builtin javascript snippet

您可以通过运行命令面板中的“插入代码片段”命令来查看特定语言的可用代码片段，从而获得当前文件语言的代码片段列表。但是，请记住，此列表还包括您定义的自定义代码片段以及通过已安装的扩展提供的代码片段。

从 Marketplace 安装代码片段

VS Code Marketplace 上的许多扩展都包含代码片段。您可以使用 @category:"snippets" 过滤器在扩展视图（⇧⌘X (Windows、Linux Ctrl+Shift+X)）中搜索包含代码片段的扩展。

Searching for extensions with snippets

如果您找到想要使用的扩展，请安装它，然后重启 VS Code，新的代码片段就会可用。

创建自己的代码片段

您可以轻松地定义自己的代码片段，而无需任何扩展。要创建或编辑自己的代码片段，请在**文件 > 首选项**下选择**配置代码片段**，然后选择代码片段应显示的语言（通过语言标识符），或者如果它们应显示给所有语言，则选择**新建全局代码片段文件**选项。VS Code 会为您管理底层代码片段文件的创建和刷新。

snippet dropdown

代码片段文件使用 JSON 编写，支持 C 风格的注释，并且可以定义无限数量的代码片段。代码片段支持大多数 TextMate 语法以实现动态行为，根据插入上下文智能格式化空格，并允许轻松进行多行编辑。

以下是一个 JavaScript `for` 循环代码片段的示例

// in file 'Code/User/snippets/javascript.json'
{
  "For Loop": {
    "prefix": ["for", "for-const"],
    "body": ["for (const ${2:element} of ${1:array}) {", "\t$0", "}"],
    "description": "A for loop."
  }
}

在上面的示例中

  • “For Loop”是代码片段的名称。如果未提供 description，它将通过 IntelliSense 显示。
  • prefix 定义一个或多个用于在 IntelliSense 中显示代码片段的触发词。会根据前缀执行子字符串匹配，因此在这种情况下，“fc”可以匹配“for-const”。
  • body 是一行或多行内容，在插入时将合并为多行。换行符和嵌入的制表符将根据代码片段插入的上下文进行格式化。
  • description 是 IntelliSense 显示的代码片段的可选描述。

此外，上面示例的 body 包含三个占位符（按遍历顺序排列）：${1:array}、${2:element} 和 $0。您可以使用 Tab 快速跳转到下一个占位符，此时您可以编辑该占位符或跳转到下一个。冒号 : 之后的字符串（如果有）是默认文本，例如 ${2:element} 中的 element。占位符的遍历顺序按数字升序排列，从一开始；零是一个可选的特殊情况，始终放在最后，并以指定的光标位置退出代码片段模式。

文件模板代码片段

如果代码片段旨在填充或替换文件的内容，您可以将 isFileTemplate 属性添加到代码片段的定义中。文件模板代码片段会在您在新文件或现有文件中运行“代码片段：使用代码片段填充文件”命令时显示在下拉列表中。

代码片段作用域

代码片段具有作用域，以便仅建议相关的代码片段。代码片段可以通过以下方式进行作用域限定：

  1. 代码片段的作用域是**语言**（可能全部）
  2. 代码片段的作用域是**项目**（可能全部）

语言代码片段作用域

每个代码片段都作用于一种、多种或全部（“全局”）语言，具体取决于它是在以下位置定义的：

  1. **语言**代码片段文件
  2. **全局**代码片段文件

单语言自定义代码片段定义在特定语言的代码片段文件中（例如 javascript.json），您可以通过“代码片段：配置代码片段”按语言标识符访问。只有在编辑定义该代码片段的语言时，代码片段才可用。

多语言和全局自定义代码片段均定义在“全局”代码片段文件中（文件后缀为 .code-snippets 的 JSON），这也通过“代码片段：配置代码片段”访问。在全局代码片段文件中，代码片段定义可以有一个额外的 scope 属性，该属性接受一个或多个语言标识符，从而使代码片段仅对指定的语言可用。如果没有 scope 属性，则全局代码片段在**所有**语言中都可用。

大多数自定义代码片段的作用域是单一语言，因此定义在特定语言的代码片段文件中。

项目代码片段作用域

您还可以有一个作用域限定为项目的全局代码片段文件（文件后缀为 .code-snippets 的 JSON）。项目文件夹代码片段是通过“代码片段：配置代码片段”下拉菜单中的“为‘<文件夹名称>’新建代码片段文件...”选项创建的，并且位于项目根目录的 .vscode 文件夹中。项目代码片段文件对于与该项目中的所有用户共享代码片段非常有用。项目文件夹代码片段类似于全局代码片段，并且可以通过 scope 属性作用于特定语言。

代码片段语法

代码片段的 body 可以使用特殊构造来控制光标和插入的文本。以下是支持的功能及其语法：

制表位

使用制表位，您可以使编辑器光标在代码片段内部移动。使用 $1、$2 指定光标位置。数字表示制表位访问的顺序，而 $0 表示最终光标位置。同一制表位的多个出现是链接的，并同步更新。

占位符

占位符是带有值的制表位，例如 ${1:foo}。占位符文本将被插入并选中，以便轻松修改。占位符可以嵌套，例如 ${1:another ${2:placeholder}}。

选择

占位符的值可以是选择项。语法是用管道符括起来的逗号分隔的值列表，例如 ${1|one,two,three|}。插入代码片段并选择占位符时，将提示用户选择一个值。

变量

使用 $name 或 ${name:default}，您可以插入变量的值。当变量未设置时，将插入其 **default** 或空字符串。当变量未知（即其名称未定义）时，将插入变量的名称，并将其转换为占位符。

以下变量可用：

  • TM_SELECTED_TEXT 当前选定的文本或空字符串
  • TM_CURRENT_LINE 当前行的内容
  • TM_CURRENT_WORD 光标下的单词的内容或空字符串
  • TM_LINE_INDEX 基于零的行号
  • TM_LINE_NUMBER 基于一的行号
  • TM_FILENAME 当前文档的文件名
  • TM_FILENAME_BASE 当前文档的文件名（不含扩展名）
  • TM_DIRECTORY 当前文档的目录
  • TM_FILEPATH 当前文档的完整文件路径
  • RELATIVE_FILEPATH 当前文档的（相对于打开的工作区或文件夹的）相对文件路径
  • CLIPBOARD 剪贴板的内容
  • WORKSPACE_NAME 打开的工作区或文件夹的名称
  • WORKSPACE_FOLDER 打开的工作区或文件夹的路径
  • CURSOR_INDEX 基于零的光标编号
  • CURSOR_NUMBER 基于一的光标编号

用于插入当前日期和时间

  • CURRENT_YEAR 当前年份
  • CURRENT_YEAR_SHORT 当前年份的最后两位数字
  • CURRENT_MONTH 月份（两位数字，例如“02”）
  • CURRENT_MONTH_NAME 月份的全名（例如“July”）
  • CURRENT_MONTH_NAME_SHORT 月份的简称（例如“Jul”）
  • CURRENT_DATE 月份（两位数字，例如“08”）
  • CURRENT_DAY_NAME 星期名称（例如“Monday”）
  • CURRENT_DAY_NAME_SHORT 星期简称（例如“Mon”）
  • CURRENT_HOUR 当前小时（24 小时制）
  • CURRENT_MINUTE 当前分钟（两位数字）
  • CURRENT_SECOND 当前秒（两位数字）
  • CURRENT_SECONDS_UNIX 自 Unix 纪元以来的秒数
  • CURRENT_TIMEZONE_OFFSET 当前 UTC 时区偏移量，格式为 +HH:MM 或 -HH:MM（例如 -07:00）。

用于插入随机值

  • RANDOM 6 位随机十进制数字
  • RANDOM_HEX 6 位随机十六进制数字
  • UUID 版本 4 UUID

用于插入行注释或块注释，遵循当前语言

  • BLOCK_COMMENT_START 示例输出：在 PHP 中为 /* 或在 HTML 中为 <!--
  • BLOCK_COMMENT_END 示例输出：在 PHP 中为 */ 或在 HTML 中为 -->
  • LINE_COMMENT 示例输出：在 PHP 中为 //

以下代码片段在 JavaScript 文件中插入 /* Hello World */，在 HTML 文件中插入 <!-- Hello World -->

{
  "hello": {
    "scope": "javascript,html",
    "prefix": "hello",
    "body": "$BLOCK_COMMENT_START Hello World $BLOCK_COMMENT_END"
  }
}

变量转换

转换允许您在变量插入之前修改其值。转换的定义包含三个部分：

  1. 与变量值（或变量无法解析时的空字符串）匹配的正则表达式。
  2. 允许引用正则表达式匹配组的“格式字符串”。格式字符串允许条件插入和简单修改。
  3. 传递给正则表达式的选项。

以下示例插入当前文件名（不带扩展名）的名称，例如从 foo.txt 得到 foo。

${TM_FILENAME/(.*)\\..+$/$1/}
  |           |         |  |
  |           |         |  |-> no options
  |           |         |
  |           |         |-> references the contents of the first
  |           |             capture group
  |           |
  |           |-> regex to capture everything before
  |               the final `.suffix`
  |
  |-> resolves to the filename

占位符转换

与变量转换类似，占位符转换允许在移动到下一个制表位时更改占位符的插入文本。插入的文本与正则表达式匹配，匹配项（取决于选项）会被指定的替换格式文本替换。每个占位符都可以使用第一个占位符的值独立定义自己的转换。占位符转换的格式与变量转换相同。

转换示例

示例显示在双引号中，就像它们出现在代码片段主体中一样，以说明需要双重转义某些字符。示例转换以及文件名 example-123.456-TEST.js 的结果输出。

示例 输出 解释
"${TM_FILENAME/[\\.]/_/}" example-123_456-TEST.js 将第一个 . 替换为 _
"${TM_FILENAME/[\\.-]/_/g}" example_123_456_TEST_js 将每个 . 或 - 替换为 _
"${TM_FILENAME/(.*)/${1:/upcase}/}" EXAMPLE-123.456-TEST.JS 更改为全部大写
"${TM_FILENAME/[^0-9a-z]//gi}" example123456TESTjs 删除非字母数字字符

语法

以下是代码片段的 EBNF（扩展巴科斯-瑙尔形式）。使用 \（反斜杠），您可以转义 $、} 和 \。在选择元素内部，反斜杠还会转义逗号和管道字符。只能转义需要转义的字符，因此 $ 不应在这些构造中转义，也不应在选择构造内部转义 $ 或 }。

any         ::= tabstop | placeholder | choice | variable | text
tabstop     ::= '$' int
                | '${' int '}'
                | '${' int  transform '}'
placeholder ::= '${' int ':' any '}'
choice      ::= '${' int '|' text (',' text)* '|}'
variable    ::= '$' var | '${' var '}'
                | '${' var ':' any '}'
                | '${' var transform '}'
transform   ::= '/' regex '/' (format | text)+ '/' options
format      ::= '$' int | '${' int '}'
                | '${' int ':' '/upcase' | '/downcase' | '/capitalize' | '/camelcase' | '/pascalcase' '}'
                | '${' int ':+' if '}'
                | '${' int ':?' if ':' else '}'
                | '${' int ':-' else '}' | '${' int ':' else '}'
regex       ::= JavaScript Regular Expression value (ctor-string)
options     ::= JavaScript Regular Expression option (ctor-options)
var         ::= [_a-zA-Z] [_a-zA-Z0-9]*
int         ::= [0-9]+
text        ::= .*
if          ::= text
else        ::= text

使用 TextMate 代码片段

您还可以使用现有的 TextMate 代码片段（.tmSnippets）与 VS Code 结合使用。请参阅我们扩展 API 部分的使用 TextMate 代码片段主题以了解更多信息。

为代码片段分配键盘快捷键

您可以创建自定义键盘快捷键来插入特定代码片段。打开 keybindings.json（**首选项：打开键盘快捷键文件**），其中定义了您所有的键盘快捷键，然后添加一个键盘快捷键，将 "snippet" 作为附加参数传递。

{
  "key": "cmd+k 1",
  "command": "editor.action.insertSnippet",
  "when": "editorTextFocus",
  "args": {
    "snippet": "console.log($1)$0"
  }
}

键盘快捷键将调用“插入代码片段”命令，但它不会提示您选择代码片段，而是会插入提供的代码片段。您可以像往常一样使用键盘快捷键、命令 ID 和可选的when 子句上下文来定义自定义键绑定，以确定键盘快捷键何时启用。

此外，您可以使用 langId 和 name 参数引用现有代码片段，而不是使用 snippet 参数值来内联定义代码片段。langId 参数选择代码片段 name 所属的语言，例如下面的示例选择在 csharp 文件中可用的 myFavSnippet。

{
  "key": "cmd+k 1",
  "command": "editor.action.insertSnippet",
  "when": "editorTextFocus",
  "args": {
    "langId": "csharp",
    "name": "myFavSnippet"
  }
}

后续步骤

  • 命令行 - VS Code 具有丰富的命令行界面，用于打开或比较文件以及安装扩展。
  • 扩展 API - 了解扩展 VS Code 的其他方法。
  • 代码片段指南 - 您可以打包代码片段供 VS Code 使用。

常见问题

如果我想使用 .tmSnippet 文件中的现有 TextMate 代码片段怎么办？

您可以轻松地打包 TextMate 代码片段文件以供 VS Code 使用。请参阅我们扩展 API 文档中的使用 TextMate 代码片段。

我如何让代码片段在粘贴的脚本中插入变量？

要在粘贴的脚本中插入变量，您需要转义 $variable 名称中的“$”，以免它被代码片段展开阶段解析。

"VariableSnippet":{
    "prefix": "_Var",
    "body": "\\$MyVar = 2",
    "description": "A basic snippet that places a variable into script with the $ prefix"
  }

这会导致粘贴的代码片段如下所示：

$MyVar = 2

我可以从 IntelliSense 中移除代码片段吗？

是的，您可以通过在“插入代码片段”命令下拉列表中选择右侧的“从 IntelliSense 隐藏”按钮，来隐藏特定的代码片段，使其不显示在 IntelliSense（完成列表）中。

Hide from IntelliSense button in Insert Snippet dropdown

您仍然可以使用“插入代码片段”命令选择该代码片段，但隐藏的代码片段不会显示在 IntelliSense 中。

01/08/2026
English 한국어 中文(简体)
© . This site is unofficial and not affiliated with Microsoft.