聊聊VSCode中Snippet插件的使用(提高编程效率)

本文介绍的是 vscode snippet 插件,一种代码片段配置插件,可以节省你写样板代码的时间。

聊聊VSCode中Snippet插件的使用(提高编程效率)

你可能之前学习过 VSCode Snippet 插件,知道它的作用也学习了配置的语法,但是你想不到落地使用的场景。本文也将解决你的这个疑惑~

本文将介绍 VSCode Snippet 的使用介绍、配置语法、引入方式和使用场景。【推荐学习:vscode教程、编程教学】

VSCode Snippet 插件使用简介

image

立即进入“豆包AI人工智官网入口”;

立即学习“豆包AI人工智能在线问答入口”;

(图片来自于 VSCode 官网)

如 gif 图所示,当你想编写一段 ajax 代码时,只需要在编辑器里输入 ajax,再点击下 Tab 键,就会为你自动生成 ajax 代码的模板。

Snippet 支持我们配置自己想要的任意代码片段,因此我们可以把项目中常见的代码片段抽出来,提高编程效率。同时可以共享给所在的团队,提高整个团队的编程效率。

Snippet 配置语法

我们拿 antd 组件库举例,比如我们想配置 antd 的 Snippet 代码片段:

Antd Selet 组件代码如下:


对应的 Snippet 配置代码如下:

{    "antd/Select": {        "prefix": ["Select"],        "body": [            ""        ],        "description": "Antd Select UI 组件"    }}

字段含义:

prefix 是触发 snippets 的前缀,可以通过数组指定多个

body 是填入到编辑器的内容

description 是 snippets 的描述

body 部分可以通过 ${} 的方式指定光标位置、顺序、占位字符串、可用的值等

${} 语法简介:

光标跳转:1112:

占位符:${1: placeholder}

可选值:${1|text1,text2,text3|}

变量:$变量名

在模版可编辑位置填入内容的时候,有的时候需要用到选中的值、剪贴板的值、文件名、日期等,这些信息通过 snippets 中支持的变量来取。

比如:*   TM_FILENAME: 文件名*   TM_CURRENT_LINE: 当前行的内容*   CLIPBOARD: 剪贴板内容*   WORKSPACE_NAME:workspace 的名字*   WORKSPACE_PATH:workspace 的路径*   CURRENT_YEAR:当前年*   CURRENT_MONTH:当前月*   CURRENT_DATE:当前日*   RANDOM: 随机数*   RANDOM_HEX: 6 位随机 16 进制数*   UUID: 唯一 id

可以取这些变量的值来填入到光标位置,方式就是使用 TM_FILENAME、TM_FILENAME、TM_FILENAME、CURRENT_YEAR 的方式。

Snippets 引入方式:

方式一:直接在项目中生成 .vscode/xxx.code-snippets 文件,格式为本文描述的 JSON 格式,语法如上述介绍。操作方式:

方式二:发布 VS Code 插件:

Sinppets 插件使用场景:

使用一些开源组件库可以找寻是否已经存在 Snippet 插件,例如 antd 的 snippet 插件:github.com/bang88/antd…

如果你的项目使用了某个开源的框架/组件库,这个开源项目没有配套的 Snippets 插件,那么已经学会封装 Snippets 插件的你,快快动起勤劳的小手,是时候为你的团队或者社区做些贡献啦~

如果你的项目中,基于 antd 等 UI 组件库,又封装了一些自己业务的公共组件,那么可以给这些业务相关的公共的组件封装一个 Snippets 插件,提高你团队的效率

除了 JSX 类的组件,一些常用的工具函数也可以抽象 Snippets 插件代码片段

更多关于VSCode的相关知识,请访问:vscode基础教程!

以上就是聊聊VSCode中Snippet插件的使用(提高编程效率)的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/55685.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
苹果推出 Safari 190 预览版:修复和改善了多项功能
上一篇 2025年11月9日 21:56:20
当事人回应手拿折扇被误认持刀:到现在人都是蒙的
下一篇 2025年11月9日 21:59:23

相关推荐

发表回复

登录后才能评论
关注微信