0

0

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

P粉986688829

P粉986688829

发布时间:2025-12-19 18:19:02

|

141人浏览过

|

来源于php中文网

原创

VSCode代码片段可大幅提升编码效率。一、用户级片段适用于通用逻辑,通过命令面板配置JSON文件实现;二、工作区片段仅限当前项目,需在.vscode/snippets/下创建;三、支持内置变量、正则转换、条件占位符等动态功能;四、管理时注意prefix长度、description清晰性,修改后保存即生效。

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

VSCode 的代码片段(Snippets)能帮你省下大量重复敲代码的时间,尤其适合常用结构、组件模板或特定框架的样板代码。关键不是“能不能写”,而是“怎么写得顺手、好维护、真有用”。

一、创建你自己的用户级代码片段

这是最灵活的方式,适用于通用逻辑,比如 console.log、函数声明、React 函数组件等。

  • 打开命令面板(Ctrl+Shift+PCmd+Shift+P),输入 Preferences: Configure User Snippets
  • 选择语言(如 JavaScript)或新建全局文件(选 New Global Snippets file
  • VSCode 会生成一个 javascript.json(或 snippets.code-snippets)文件,里面是 JSON 格式

例如,加一个快速打印变量名和值的 snippet:

{
  "log with name": {
    "prefix": "ln",
    "body": ["console.log('$1:', $1);"],
    "description": "console.log('varName:', varName)"
  }
}

保存后,在 JS 文件中输入 ln + Tab,就会展开成 console.log('xxx:', xxx);,光标自动停在 xxx 位置供你编辑。

二、为特定项目定制工作区片段

如果你的团队有统一的组件结构、API 调用模式或测试写法,用工作区片段更合适——它只在当前文件夹生效,不污染全局。

  • 在项目根目录创建 .vscode/snippets/ 文件夹
  • 在里面新建 react-component.json(文件名随意,后缀必须是 .json)
  • 内容格式和用户 snippet 完全一样,但只对这个工作区生效

比如定义一个 React 函数组件骨架:

Avactis购物车
Avactis购物车

Avactis是一个强大的PHP在线购物系统拥有多个版本包括开源版本。它具备一个在线购物系统所需要的所有功能从产品到会员管理,订单和营销。可以无限分类和为产品指定任务数量的图片(支持自动生成缩略图)。使用自定义字段功能,让你可以更好地定义一个产品。该系统提供以非常灵活的方式来创建任意类型的促销活动如设置折扣代码,基于价格的折扣或基于数量的折扣等。

下载
{
  "React FC": {
    "prefix": "rfc",
    "body": [
      "const $1 = () => {",
      "  return (",
      "    <$2>",
      "      $0",
      "    ",
      "  );",
      "};",
      "",
      "export default $1;"
    ],
    "description": "React functional component"
  }
}

$1 是第一个跳转位(组件名),$2 是第二个(根标签),$0 是最终光标停留处。按 Tab 键可顺序切换占位符。

三、实用技巧:让 snippet 更聪明

纯静态替换只是入门。真正提效的是带逻辑的动态内容:

  • 变量支持:除了 $1,还能用 ${TM_FILENAME_BASE}(当前文件名无后缀)、${CURRENT_YEAR}${CLIPBOARD} 等内置变量
  • 简单转换:比如把输入的 userName 自动转成 user-name${1/(.*)/${1:/kebabcase}/}
  • 条件占位符:支持 ${1:default},没输入时显示默认值;${1?yes:no} 可做简易判断(较少用,但存在)
  • 多行缩进自动对齐:VSCode 会根据你触发 snippet 时的缩进级别,自动调整整个代码块的缩进

四、管理和调试 snippet

写多了容易混乱,几个小建议:

  • prefix 别太短(比如 c 太泛),也别太长(my-awesome-react-component-boilerplate 不现实),2~4 字母较平衡(rfcuseq
  • description 要写清楚用途,尤其多人共用时,避免“what is this?”尴尬
  • 改完 snippet 后不用重启 VSCode,保存即生效
  • 如果没反应,检查 language ID 是否匹配(比如你在 TypeScript 文件里写了 JavaScript snippet,就可能不触发)

可以在命令面板运行 Developer: Toggle Developer Tools 查看控制台是否有 snippet 加载错误。

基本上就这些。不需要写插件、不用编译,改个 JSON 就能立刻提升日常编码节奏。关键是从小处开始——先把你每天敲 5 遍以上的结构做成 snippet,慢慢叠加,效率自然上来。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
json数据格式
json数据格式

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

312

2023.10.13

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

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

77

2025.09.10

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

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

515

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

245

2023.07.28

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

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

320

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5330

2023.08.17

2026赚钱平台入口大全
2026赚钱平台入口大全

2026年最新赚钱平台入口汇总,涵盖任务众包、内容创作、电商运营、技能变现等多类正规渠道,助你轻松开启副业增收之路。阅读专题下面的文章了解更多详细内容。

8

2026.01.31

热门下载

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

相关下载

更多

精品课程

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

共23课时 | 3万人学习

C# 教程
C# 教程

共94课时 | 8.1万人学习

Java 教程
Java 教程

共578课时 | 54万人学习

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

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