首先创建自定义代码片段,通过命令面板选择全局或语言特定配置,编辑jsON文件定义名称、前缀、主体和描述,支持变量与占位符如$TM_FILENAME和$CURRENT_YEAR,保存后在编辑器输入前缀触发,按Tab或Enter展开,光标自动跳转至指定位置,提升编码效率。
vscode 的代码片段(Snippets)功能可以帮助你快速插入常用的代码结构,提升编码效率。只需输入简短的前缀,就能展开成完整的代码块。下面介绍如何创建和使用自定义代码片段。
打开用户或语言专属片段文件
自定义片段可以全局使用,也可以限定在特定语言中。操作步骤如下:
- 按 Ctrl + Shift + P 打开命令面板
- 输入 “Preferences: Configure User Snippets”
- 选择:
- VSCode 会打开一个 json 格式的配置文件(全局为 snippets.json,语言则为对应语言的 json 文件)
编写自定义片段结构
每个片段由名称、前缀、主体和描述组成,格式如下:
{ “Log to console“: { “prefix”: “log”, “body”: [ “console.log(‘$1’);”, “$2” ], “description”: “输出日志到控制台” } }
说明:
- Log to Console:片段名称,可任意命名
- prefix:触发关键词,比如输入 log 后按 Tab 即可展开
- body:实际插入的代码行,支持数组形式换行
- $1、$2:光标定位点,$1 是第一个停靠位置,Tab 切换到 $2
- description:在提示框中显示的说明文字
使用变量和占位符增强灵活性
片段支持内置变量,让模板更智能:
- $TM_FILENAME:当前文件名
- $TM_DIRECTORY:文件所在路径
- $CURRENT_YEAR、$CURRENT_MONTH:当前年月
- ${1:default}:带默认值的占位符,编辑时可修改
示例:创建一个包含时间戳的注释头
“File Header”: { “prefix”: “header”, “body”: [ “/**”, ” * File: $TM_FILENAME”, ” * Created: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE”, ” * Author: ${1:Your Name}”, ” */”, “$2” ], “description”: “插入文件头注释” }
测试与调整
保存片段文件后,无需重启 VSCode。在对应语言的编辑器中输入 prefix 触发词,就会看到提示。按 Tab 或 Enter 展开,光标自动跳转到指定位置。如果未生效,检查:
- JSON 格式是否正确(可用格式化功能校验)
- 语言类型是否匹配
- 前缀是否有拼写错误
基本上就这些。合理设置常用片段,能大幅减少重复敲代码的时间。