0

0

如何利用VSCode的片段功能创建自定义模板【教程】

紅蓮之龍

紅蓮之龍

发布时间:2026-01-21 20:35:03

|

576人浏览过

|

来源于php中文网

原创

vscode html5模板片段需创建html.json文件,设prefix为html5,body含带${n:default}占位符的结构化代码,保存后重载窗口生效。

vscode 的代码片段(snippets)不是“写完再补”,而是“打几个字母就自动展开成结构化模板”——关键在触发词设计和变量占位控制。

如何创建一个全局可用的 HTML5 模板片段

全局片段对所有 .html 文件生效,适合基础骨架。需编辑用户级 snippet 文件:html.json,路径通常为:~/.vscode/snippets/html.json(macOS/Linux)或 %USERPROFILE%\AppData\Roaming\Code\User\snippets\html.json(Windows)。

内容示例:

{
  "html5 boilerplate": {
    "prefix": "html5",
    "body": [
      "<!DOCTYPE html>",
      "<html lang=\"${1:zh-CN}\">",
      "<head>",
      "  <meta charset=\"${2:UTF-8}\">",
      "  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">",
      "  <title>${3:Document}</title>",
      "</head>",
      "<body>",
      "  ${4:<!-- content -->}",
      "</body>",
      "</html>"
    ],
    "description": "HTML5 basic template with tabstops"
  }
}

注意点:

  • prefix 是触发关键词,输入 html5 后按 Tab 即展开
  • ${1:zh-CN} 表示第一个跳转位置,冒号后是默认值,可直接回车跳过
  • 多个 ${n:...} 按数字顺序跳转,${0} 是最终光标停留位
  • 文件必须是合法 JSON,末尾不能有多余逗号

如何让片段只在特定语言或文件夹中生效

片段作用域由文件名决定:全局片段放 html.json,项目级片段则放在工作区根目录的 .vscode/snippets/ 下,并命名为 javascript.jsontypescript.json 等。VSCode 会自动识别对应语言。

若需更细粒度控制(比如仅在 src/components/ 下的 .vue 文件中启用),目前无原生支持——只能靠命名区分,例如定义 prefix 为 vc-comp,靠团队约定使用。

易通cmseasy免费的企业建站程序3.0 UTF-8 日文版
易通cmseasy免费的企业建站程序3.0 UTF-8 日文版

九州易通科技开发的核心产品易通企业网站系统(CmsEasy3.0)是充分按照SEO最佳标准来开发,营销实用性非常强企业建站系统。灵活的静态化控制,可以自定义字段,自定义模板,自定义表单,自定义URL,交叉绑定分类,地区,专题等多元化定制大大增加了企业网站的各种需求空间。强大的模板自定义可以轻松打造出个性的栏目封面,文章列表,图片列表,下载列表,分类列表,地区列表等等。主体功能列表如下:支持生成ht

下载

常见误区:

  • vue.json 放进用户 snippets 目录,但未安装官方 Vue 扩展,VSCode 不识别 .vue 语言,片段不会出现
  • 在工作区启用 "editor.suggest.snippetsPreventQuickSuggestions": false,否则输入 prefix 后可能不显示片段建议

为什么输入 prefix 后没反应?排查这三处

最常卡在这几个环节,不是配置错,而是环境没对上:

  • 当前文件后缀是否匹配片段所在 JSON 文件名?例如在 index.tsx 中输 log,但片段只定义在 javascript.json 里 → 需复制到 typescriptreact.json 或改用 typescript.json
  • 是否误将 snippet 写在了错误的 JSON 字段下?正确结构是外层为对象,key 是片段名,value 是含 prefix/body 的对象,不是直接写 body 数组
  • VSCode 是否已重载窗口?修改 snippet 文件后,需按 Ctrl+Shift+P(或 Cmd+Shift+P)→ 输入 Developer: Reload Window 才生效

进阶:用变量和嵌入逻辑生成动态内容

VSCode 原生不支持条件判断或函数调用,但可组合内置变量提升效率:

  • $TM_FILENAME_BASE → 当前文件名(不含后缀),适合生成组件名:const ${TM_FILENAME_BASE} = () => { ... }
  • $CURRENT_YEAR$CURRENT_MONTH → 自动生成版权头注释
  • $1$9 可重复使用:比如 console.log('$1', $1);,填入 user 后自动变成 console.log('user', user);

注意:$1${1:default} 不兼容混用;同一数字编号的占位符会同步更新,但不同编号之间无联动。

真正难的是平衡复用性与上下文感知——比如一个 React 组件模板,既要适配 .tsx 又要兼容 .jsx,还得预留 props 类型插入点。这时候与其堆变量,不如拆成 rc-fc(函数组件)、rc-cc(类组件)两个 prefix,手动选更稳。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

47

2026.02.13

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

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

191

2026.02.25

json数据格式
json数据格式

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

455

2023.08.07

json是什么
json是什么

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

546

2023.08.23

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

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

334

2023.10.13

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

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

82

2025.09.10

html5动画制作有哪些制作方法
html5动画制作有哪些制作方法

html5动画制作方法有使用CSS3动画、使用JavaScript动画库、使用HTML5 Canvas等。想了解更多html5动画制作方法相关内容,可以阅读本专题下面的文章。

550

2023.10.23

HTML与HTML5的区别
HTML与HTML5的区别

HTML与HTML5的区别:1、html5支持矢量图形,html本身不支持;2、html5中可临时存储数据,html不行;3、html5新增了许多控件;4、html本身不支持音频和视频,html5支持;5、html无法处理不准确的语法,html5能够处理等等。想了解更多HTML与HTML5的相关内容,可以阅读本专题下面的文章。

470

2024.03.06

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

3

2026.03.11

热门下载

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

精品课程

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

共48课时 | 10.5万人学习

Git 教程
Git 教程

共21课时 | 4.1万人学习

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

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