讲师中心 微信公众号
AI工具推荐 视频效率加速

VSCode如何实现代码片段的创建与使用?【教程】

浅辰大大_3504

浅辰大大_3504

发布时间:2026-01-20 19:54:09

|

863人浏览过

|

来源于php中文网

原创

VSCode代码片段是内置功能,非插件实现;需按语言建对应JSON文件(如typescript.json),或选全局创建common.code-snippets;结构含prefix、body、description,支持变量与光标跳转。

vscode如何实现代码片段的创建与使用?【教程】

VSCode 的代码片段(Snippets)不是靠插件实现的,而是内置功能,只要路径和格式对,改完就能立刻生效。

如何创建自定义代码片段文件

VSCode 的代码片段以 JSON 格式组织,存放在特定目录下。不同语言对应不同文件,比如写 TypeScript 就建 typescript.json,写 Python 就建 python.json。

  • 打开命令面板(Ctrl+Shift+P 或 Cmd+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 是包含 prefix、body、description 的对象。最简结构如下:

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
{
  "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-snippets、api.code-snippets),而不是全塞进一个大 JSON 里。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

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

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

272

2026.02.13

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

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

480

2026.02.25

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

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

331

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

246

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

498

2026.06.16

json数据格式
json数据格式

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

1995

2023.08.07

json是什么
json是什么

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

2842

2023.08.23

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

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

976

2023.10.13

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

20

2026.09.30

热门下载

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

精品课程

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

共58课时 | 12万人学习

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

共12课时 | 1.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn