0

0

在VSCode中创建和使用你自己的代码片段(Snippets)

P粉986688829

P粉986688829

发布时间:2025-12-26 13:37:02

|

143人浏览过

|

来源于php中文网

原创

VSCode支持通过自定义代码片段快速插入常用结构,需依次创建用户级或工作区级JSON片段文件,按prefix/body/description规范编写,保存后在对应语言文件中输入前缀按Tab展开使用。

在vscode中创建和使用你自己的代码片段(snippets)

如果您希望在编写代码时快速插入常用代码结构,VSCode 提供了自定义代码片段(Snippets)功能,允许您为特定语言创建可复用的模板。以下是实现该功能的具体步骤:

本文运行环境:MacBook Air,macOS Sequoia。

一、创建用户级代码片段文件

用户级代码片段适用于所有工作区中的指定语言,通过全局 JSON 文件定义,便于统一管理和跨项目复用。

1、打开 VSCode,按下 Cmd + Shift + P(Windows/Linux 为 Ctrl + Shift + P),调出命令面板。

2、输入并选择 Preferences: Configure User Snippets

3、在弹出的菜单中选择目标编程语言(例如 javascript)或选择 New Global Snippets file... 创建通用片段。

4、输入文件名(如 my-react-snippets.code-snippets),回车确认,VSCode 将自动创建并打开一个 JSON 格式的空片段文件。

二、编写符合语法规范的片段内容

每个代码片段需以唯一键名标识,包含前缀(prefix)、主体(body)和描述(description)三个核心字段,body 中支持制表符占位与变量语法。

1、在打开的 JSON 文件中,删除默认注释,按如下结构填入内容:

2、键名使用小写字母与短横线组合,例如 log-console

3、在对应键对象内添加 "prefix": "log" 字段,用于触发补全。

4、设置 "body": ["console.log('$1');", "$2"],其中 $1 表示首个光标停靠点,$2 为第二个停靠点,支持 Tab 键跳转。

5、添加 "description": "Insert console.log() with cursor inside" 字段,便于在补全列表中识别。

三、为特定工作区配置专属片段

工作区级片段仅在当前文件夹生效,适合项目私有模板(如 API 请求封装、组件骨架),避免污染全局环境。

1、在当前项目根目录下创建 .vscode/ 文件夹(若不存在)。

Riffo
Riffo

Riffo是一个免费的文件智能命名和管理工具

下载

2、在该文件夹中新建文件,命名为 snippets.json

3、在文件中按标准 JSON 格式编写片段对象,键名为语言 ID(如 typescripthtml)。

4、确保外层结构为 { "typescript": { ... } },内部嵌套各片段定义。

四、在编辑器中触发并使用代码片段

片段启用后,无需重启编辑器,只要在对应语言文件中输入前缀并按下 Tab 键即可展开,光标将按 body 中定义的顺序自动定位。

1、新建或打开一个 .js 文件。

2、输入已定义的前缀(如 log),此时编辑器显示补全建议。

3、按 TabEnter 确认展开,首处光标停在引号内。

4、输入日志内容后,再按 Tab 跳至下一个占位点(如 $2)。

五、调试与验证片段是否生效

当片段未出现在补全列表或无法展开时,需检查语法合法性、语言匹配性及文件路径正确性,VSCode 会在非法 JSON 处给出红色波浪线提示。

1、保存片段文件后,打开对应语言的文件,输入前缀并观察是否出现补全项。

2、若无响应,检查右下角语言模式是否与片段绑定语言一致(如显示 JavaScript 而非 Plain Text)。

3、打开命令面板,执行 Developer: Toggle Developer Tools,查看 Console 是否报错。

4、确认片段 JSON 中无逗号遗漏、引号不闭合、键名含非法字符等基础语法错误。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

50

2026.02.13

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

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

199

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

120

2026.03.13

json数据格式
json数据格式

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

458

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

84

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

532

2023.06.20

Python WebSocket实时通信与异步服务开发实践
Python WebSocket实时通信与异步服务开发实践

本专题聚焦 Python 在实时通信场景中的开发实践,系统讲解 WebSocket 协议原理、长连接管理、消息推送机制以及异步服务架构设计。内容包括客户端与服务端通信实现、连接稳定性优化、消息队列集成及高并发处理策略。通过完整案例,帮助开发者构建高效稳定的实时通信系统,适用于聊天应用、实时数据推送等场景。

7

2026.03.18

热门下载

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

精品课程

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

共48课时 | 10.9万人学习

Git 教程
Git 教程

共21课时 | 4.3万人学习

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

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