0

0

VSCode如何实现代码片段的创建与使用?【教程】

幻影之瞳

幻影之瞳

发布时间:2026-01-20 19:54:09

|

823人浏览过

|

来源于php中文网

原创

vscode代码片段是内置功能,非插件实现;需按语言建对应json文件(如typescript.json),或选全局创建common.code-snippets;结构含prefix、body、description,支持变量与光标跳转。

vscode如何实现代码片段的创建与使用?【教程】

VSCode 的代码片段(Snippets)不是靠插件实现的,而是内置功能,只要路径和格式对,改完就能立刻生效。

如何创建自定义代码片段文件

VSCode 的代码片段以 JSON 格式组织,存放在特定目录下。不同语言对应不同文件,比如写 TypeScript 就建 typescript.json,写 Python 就建 python.json

  • 打开命令面板(Ctrl+Shift+PCmd+Shift+P),输入并选择 Preferences: Configure User Snippets
  • 选中目标语言(如 javascript),会自动打开或创建 javascript.json
  • 若要全局生效(所有语言都可用),选 New Global Snippets file...,文件名建议用 common.code-snippets

注意:文件名必须是 .json 后缀,且不能是 .code-snippets —— 除非你选的是「全局」选项,否则 VSCode 不认。

代码片段的 JSON 结构怎么写

每个片段是一个键值对,key 是触发词(tab trigger),value 是包含 prefixbodydescription 的对象。最简结构如下:

盛世企业网站管理系统1.1.2
盛世企业网站管理系统1.1.2

免费 盛世企业网站管理系统(SnSee)系统完全免费使用,无任何功能模块使用限制,在使用过程中如遇到相关问题可以去官方论坛参与讨论。开源 系统Web代码完全开源,在您使用过程中可以根据自已实际情况加以调整或修改,完全可以满足您的需求。强大且灵活 独创的多语言功能,可以直接在后台自由设定语言版本,其语言版本不限数量,可根据自已需要进行任意设置;系统各模块可在后台自由设置及开启;强大且适用的后台管理支

下载
{
  "log console": {
    "prefix": "log",
    "body": ["console.log('$1');", "$2"],
    "description": "console.log with placeholder"
  }
}
  • prefix 是你在编辑器里输入后按 Tab 触发的关键词,比如输 log 再按 Tab
  • body 是插入的内容,数组每项是一行;$1$2 是光标跳转位置,$0 是最终停留点
  • 支持变量如 $TM_FILENAME_BASE(当前文件名不含后缀)、$CURRENT_YEAR,完整列表见 VSCode 官方文档 Variables in snippets

别漏掉逗号,JSON 对语法敏感;如果片段没生效,先检查控制台(Help > Toggle Developer Tools)有没有报错 invalid json

为什么写了片段却没反应

常见原因不是配置错,而是触发逻辑被忽略:

  • 当前文件语言模式不匹配:右下角状态栏显示的是 Plain Text,但你的片段在 javascript.json 里 → 点击它,改成 JavaScript
  • 片段放在了错误位置:用户级片段在 User/snippets/ 下,工作区级片段需放在项目根目录 .vscode/snippets/ 中,且文件名必须为 *.code-snippets(注意后缀)
  • 前缀冲突:已有内置片段(如 for)或其它扩展注册了同名 prefix,VSCode 默认优先使用语言自带片段
  • 没重启编辑器或重载窗口:修改全局片段后,执行 Developer: Reload Window 最稳妥

进阶技巧:动态生成与多光标编辑

复杂片段可以组合变量和转义逻辑,比如生成带时间戳的注释:

{
  "ts comment": {
    "prefix": "tsc",
    "body": [
      "/**",
      " * @author $1",
      " * @created $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE",
      " */",
      "$0"
    ]
  }
}
  • $1 输入作者名后按 Tab 跳到下一处,$0 是最后光标位
  • 多行 body 自动保留缩进,但首行缩进会被当作整体偏移 → 建议用空字符串占位对齐
  • 不想让某处被跳转?用 ${1:default} 设默认值,或 ${1|a,b,c|} 提供选项(需 VSCode 1.85+)

真正麻烦的不是写法,而是维护——片段一多就难定位。建议按功能分文件(react.code-snippetsapi.code-snippets),而不是全塞进一个大 JSON 里。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

45

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

189

2026.02.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

454

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

334

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

220

2023.09.04

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

4

2026.03.10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 5.9万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号