0

0

VSCode中如何设置代码片段以减少重复性编码工作【教程】

夢幻星辰

夢幻星辰

发布时间:2026-01-23 17:25:31

|

778人浏览过

|

来源于php中文网

原创

vscode自定义代码片段需创建json配置文件,设prefix触发、body定义内容(推荐数组格式)、description说明;保存后重载窗口生效;.ts文件需在typescript.json中单独配置;支持$tm_filename_base等预定义变量。

vscode中如何设置代码片段以减少重复性编码工作【教程】

如何在 VSCode 中创建自定义代码片段

VSCode 的代码片段(snippets)本质是 JSON 配置,存放在特定路径下,触发靠 prefix 字段匹配。不是写完就生效——必须重启编辑器或重载窗口,否则新片段不会出现在补全列表中。

实操建议:

  • 打开命令面板(Ctrl+Shift+PCmd+Shift+P),输入并选择 Preferences: Configure User Snippets
  • New Global Snippets file... 创建全局片段,或选某语言(如 javascript.json)做语言专属片段
  • 按格式填写 prefixbodydescriptionbody 中用 $1$2 定义光标停靠点,$0 是最终退出位置
  • 保存后,任意该语言文件中输入 prefix 再按 Tab 即可展开

为什么 JavaScript 片段在 .ts 文件里不生效

因为 VSCode 默认按文件后缀关联语言模式,.ts 文件使用 typescript 语言模式,而你可能只配置了 javascript.json。片段不会跨语言自动继承。

解决方式:

  • typescript.json 中单独定义相同片段(推荐,语义准确)
  • 或在 javascript.json 中添加 "scope": "typescript" 字段(不推荐,易混淆)
  • 检查当前文件右下角语言标识是否为 TypeScript;若显示错误,先用命令 Change Language Mode 确认

如何让片段支持动态插入当前文件名或日期

VSCode 原生支持变量插值,但仅限于预定义变量,不支持执行 JS 表达式。常见可用变量有:$TM_FILENAME_BASE(不含扩展名的文件名)、$CURRENT_YEAR$CURRENT_MONTH$CURRENT_DATE

飞书多维表格
飞书多维表格

表格形态的AI工作流搭建工具,支持批量化的AI创作与分析任务,接入DeepSeek R1满血版

下载

示例(React 组件模板):

{
  "React Component": {
    "prefix": "rc",
    "body": [
      "import React from 'react';",
      "",
      "export default function $TM_FILENAME_BASE() {",
      "  return <div>$1</div>;",
      "}",
      "",
      "export const $TM_FILENAME_BASE = $TM_FILENAME_BASE;"
    ],
    "description": "Create a basic React component"
  }
}

注意:$TM_FILENAME_BASE 在新建未保存文件中为空字符串,此时需先保存(Ctrl+S)再触发片段,否则会生成 function () 这类语法错误。

片段中换行和缩进为何总是错乱

根本原因是 JSON 字符串内不能直接写真实换行,所有 body 必须是字符串数组或单行字符串。数组形式更可控,每项对应一行,缩进由你手动控制;若用单行字符串,则需显式写 \n 和空格,极易出错。

避坑要点:

  • 始终用数组形式写 body,避免拼接 \n
  • 数组每项开头不要加多余空格——VSCode 会以第一行的缩进为基准,自动对齐后续行
  • 如果希望展开后光标停在某缩进层级,用 $1 时确保它所在行的空格数与预期一致

复杂逻辑或需条件判断的场景,片段无能为力,得换用插件(如 Text Power Tools)或脚本生成器。别硬塞进 snippet。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的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 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

192

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的详细内容,可以访问本专题下面的文章。

335

2023.10.13

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

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

82

2025.09.10

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

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

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

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

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

76

2026.03.11

热门下载

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

精品课程

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

共58课时 | 6万人学习

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

共12课时 | 1万人学习

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

共12课时 | 1.1万人学习

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

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