0

0

如何在vscode中管理用户代码片段_创建与分享自定义模板【教程】

幻影之瞳

幻影之瞳

发布时间:2026-01-28 19:24:10

|

480人浏览过

|

来源于php中文网

原创

在 VS Code 中通过 Ctrl+Shift+P(或 Cmd+Shift+P)运行 Preferences: Configure User Snippets 命令,选择 New Global Snippets file… 或指定语言创建 JSON 片段文件,路径依系统而异;片段需按 prefix-body-description 结构编写,body 必为字符串数组,支持 $1、${1:default}、TM_FILENAME_BASE 等变量与多光标;全局片段存于 User/snippets/,项目级可放 .vscode/snippets/ 并配置 snippetSuggestions 优先级。

如何在vscode中管理用户代码片段_创建与分享自定义模板【教程】

如何在 VS Code 中打开用户代码片段文件

VS Code 的用户代码片段不是通过图形界面直接新建的,而是靠编辑 JSON 文件实现。按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(macOS),输入 Preferences: Configure User Snippets 并回车,会弹出语言选择列表;选 New Global Snippets file… 可创建跨语言通用片段,选具体语言(如 javascript)则生成对应语言专属的 javascript.code-snippets 文件。

该文件默认保存在:

  • Windows:%APPDATA%CodeUsersnippets
  • macOS:$HOME/Library/Application Support/Code/User/snippets/
  • Linux:$HOME/.config/Code/User/snippets/

代码片段 JSON 结构怎么写才有效

每个片段是一个键值对,key 是触发前缀(prefix),value 是包含 bodydescription 等字段的对象。body 必须是字符串数组,每行一条语句,换行和缩进都靠数组元素控制。

常见错误包括:

  • body 写成单个字符串(应为字符串数组)
  • 变量占位符写成 $1 但没定义 tabStop 顺序,导致跳转错乱
  • 未用双反斜杠转义 JSON 中的反斜杠(如正则 \d+

示例(React 函数组件模板):

吉卜力风格图片在线生成
吉卜力风格图片在线生成

将图片转换为吉卜力艺术风格的作品

下载
"React Functional Component": {
  "prefix": "rfc",
  "body": [
    "const $1 = () => {",
    "  return (",
    "    <div>$2</div>",
    "  );",
    "};",
    "",
    "export default $1;"
  ],
  "description": "Create a React functional component"
}

如何让自定义片段支持多光标与变量插入

VS Code 片段支持变量(如 TM_FILENAME_BASE)、占位符($1$2)和镜像($1 在多处出现时同步更新)。关键点在于:

  • 使用 $1$2 定义 tab stop 顺序,$0 表示最终光标位置
  • ${1:default} 给占位符设默认值,比如 ${1:ComponentName}
  • 变量名必须全大写且带前缀(TM_CURRENT_YEAR 等),大小写敏感
  • 避免在 body 中混用制表符和空格——VS Code 默认按 editor.tabSize 插入空格,不一致会导致缩进错乱

分享代码片段时要注意路径与语言作用域

直接发 .code-snippets 文件给别人,对方需手动放入对应 snippets 目录才能生效。更稳妥的方式是打包为 VS Code 扩展(用 yo code 脚手架),但多数场景下只需注意:

  • 全局片段(snippets.code-snippets)对所有语言生效,但若片段中写了 "scope": "javascript,typescript",就只在这些语言中触发
  • 语言专属片段(如 python.code-snippets)不会在其他语言文件中出现,哪怕前缀相同
  • 如果片段没生效,检查当前文件的语言模式是否匹配(右下角显示,可点击切换)

多人协作时,建议把常用片段放在项目根目录的 .vscode/snippets/ 下,并通过 "editor.snippetSuggestions": "top" 确保提示优先级——否则可能被内置片段盖住。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

49

2026.02.13

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

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

196

2026.02.25

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

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

68

2026.03.13

json数据格式
json数据格式

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

457

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数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

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

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

761

2023.08.03

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

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

49

2026.03.13

热门下载

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

精品课程

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

共48课时 | 10.7万人学习

Git 教程
Git 教程

共21课时 | 4.2万人学习

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

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