如何在 VS Code 中添加自定义代码补全建议（Snippet）-java教程-PHP中文网

如何在 VS Code 中添加自定义代码补全建议（Snippet）

本文介绍如何通过用户自定义代码片段（user snippets）实现输入特定缩写（如 "key"）后自动展开为预设文本（如 "key hole"），无需安装扩展，纯原生、轻量、跨语言支持。

本文介绍如何通过用户自定义代码片段（user snippets）实现输入特定缩写（如 "key"）后自动展开为预设文本（如 "key hole"），无需安装扩展，纯原生、轻量、跨语言支持。

VS Code 原生支持高度可配置的用户代码片段（User Snippets），这是实现“输入即替换”式智能补全最简洁、可靠的方式。它不同于 AI 补全或语义联想，而是基于精确前缀匹配的静态展开机制，响应快、零依赖、兼容所有语言。

✅ 快速创建自定义片段步骤：

打开命令面板（Ctrl+Shift+P / Cmd+Shift+P）；
输入并选择 Snippets: Configure User Snippets；
选择目标范围：
- New Global Snippets file → 全局生效（所有文件类型）；
- 或选择某语言（如 javascript.json）→ 仅在该语言中触发；
在打开的 JSON 文件中，按规范添加片段对象：

{
  "key hole expansion": {
    "prefix": "key",
    "body": "key hole",
    "description": "Expand 'key' to 'key hole'"
  }
}

prefix：触发补全的输入文本（区分大小写，支持多词如 "my-api"）；
body：实际插入的内容，支持换行（用 \n）、制表符（\t）及光标定位（$1, $2, $0）；
description（可选）：在补全列表中显示的提示说明；
scope（可选）：限制仅在指定语言作用域生效（如 "scope": "html,markdown"）。

⚠️ 注意事项：

片段不支持模糊匹配或子串触发（例如输入 ke 不会触发 key）；必须完整输入 prefix 后按 Tab 或从补全菜单选择；
若希望“输入即自动替换”（无需按 Tab），需配合扩展如 Auto Rename Tag 或 Text Power Tools，但原生能力仅支持显式补全；
全局片段保存在 snippets/ 目录下（可通过 Developer: Open User Data Folder 查看路径），建议定期备份；
修改后无需重启，保存即刻生效。

? 进阶示例：带光标占位与多行展开

{
  "log template": {
    "prefix": "log",
    "body": [
      "console.log('$1', $2);",
      "$0"
    ],
    "description": "Insert console.log with cursor at message"
  }
}

输入 log → 按 Tab → 光标首先进入（日志描述），再按 Tab 跳至（变量），最后 Tab 移至

输入 log → 按 Tab → 光标首先进入 $1（日志描述），再按 Tab 跳至 $2（变量），最后 Tab 移至 $0（结束位置）。

（结束位置）。