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 的对象。最简结构如下:

{
  "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 里。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

765

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

660

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

764

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

639

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1305

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

549

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

709

2023.08.11

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

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

精品课程

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

共58课时 | 3.9万人学习

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

共12课时 | 1.0万人学习

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

共12课时 | 1万人学习

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

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