使用VSCode的Snippets创建自定义代码片段

在VSCode中创建自定义代码片段可大幅提升编码效率，通过设置全局或语言级JSON模板，用prefix触发包含占位符的代码块，支持变量与多光标同步，保存后即生效。

在vscode中，代码片段（snippets）能大幅提升编码效率。通过定义常用代码模板，你可以用简短的触发词快速生成结构化代码。下面是如何创建自定义代码片段的实用方法。

打开用户或语言专属片段文件

VSCode支持全局片段和按语言设置的片段。推荐根据使用场景选择：

• 全局片段：所有项目都能用，路径为 文件 > 首选项 > 配置片段，选择“新建全局代码片段文件”
• 语言级片段：只在特定语言中生效，如 JavaScript、Vue 或 Python，选择对应语言即可

例如，想为JavaScript创建片段，选择“javascript.json”文件进行编辑。

编写片段结构

每个片段是一个JSON对象，包含触发关键词、内容和描述。基本格式如下：

{ "Log to Console": { "prefix": "log", "body": [ "console.log('$1');", "$2" ], "description": "输出日志到控制台" } }

说明：

• Log to Console：片段名称，可自定义
• prefix：输入这个单词时触发补全，比如打log就会出现提示
• body：实际插入的代码，支持多行数组写法
• $1、$2：光标停留位置，$1是第一个跳转点，Tab键可切换到$2
• description：鼠标悬停时显示的提示信息

使用变量和占位符提升灵活性

片段支持内置变量，让模板更智能：

• $TM_FILENAME：当前文件名
• $TM_LINE_NUMBER：当前行号
• ${CURSOR}：光标原始位置（较少用）
• ${1:default}：带默认值的占位符，$1位置会显示default，可直接修改

示例：创建一个组件模板

"Vue Component Template": { "prefix": "vcomp", "body": [ "", "", "", "", "" ], "description": "创建Vue单文件组件骨架" }

输入vcomp后，Tab切换位置，组件名只需改一次（三个$1同步更新）。

保存并测试片段

保存json文件后，无需重启VSCode。打开对应语言的文件，输入你设定的prefix，就会出现在自动补全列表中。回车或Tab即可插入。

如果没反应，检查：

• JSON语法是否正确（逗号、引号匹配）
• 是否在正确的语言环境下使用
• 是否有拼写错误

基本上就这些。不复杂但容易忽略细节，比如多行用数组、特殊字符转义等。熟练后，可以为React、HTML、CSS甚至Markdown建立高效模板，真正实现“一次定义，反复受益”。