讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

Laper
Laper

剧本策划到成片协作

Seko
Seko

AI短剧一键生成成片

SoundView
SoundView

字幕擦除翻译、配音口型同步

Sublime代码块注释模板怎么做?快捷片段制作教程

冬瑶姑娘_2242

冬瑶姑娘_2242

发布时间:2026-11-18 05:24:01

|

879人浏览过

|

来源于php中文网

原创

Sublime的代码块注释模板必须做成.sublime-snippet文件并严格匹配scope(如source.js、source.vue meta.script.js),否则Tab失效;需用Developer: Show Scope Name查准scope,通过Tools: New Snippet创建,保存至Packages/User/目录,文件名以.sublime-snippet结尾;复杂场景推荐DocBlockr插件实现上下文感知注释。

sublime代码块注释模板怎么做?快捷片段制作教程

Sublime 的代码块注释模板不是靠“写个 JSON 就生效”,而是必须做成 .sublime-snippet 文件,并严格匹配当前文件的 scope —— 否则按 Tab 就是静默失败。

为什么 /** + Tab 不生成注释?先查 scope 是不是对得上

Sublime 不认你右下角写的 “JavaScript” 或 “Vue”,它只认内部作用域名,比如 source.js、source.vue meta.script.js,甚至 source.tsx meta.jsx。错一个层级,片段就完全不触发。

  • 把光标放在你想插入注释的位置(比如函数名前)
  • 按 Ctrl+Shift+P(Win/Linux)或 Cmd+Shift+P(macOS)→ 输入 Developer: Show Scope Name 回车
  • 状态栏会显示一长串,例如 source.js meta.function.js → 取最左边的主干 source.js,或完整链都填进去
  • <scope></scope> 标签里写成 <scope>source.js, source.tsx, source.vue meta.script.js</scope>,用英文逗号分隔

怎么写一个 /** 模板 snippet?别手写 XML

手动新建 .xml 文件再改后缀极易出错:漏 、编码声明不对、标签闭合错位都会导致整个 snippet 加载失败。

  • 按 Ctrl+Shift+P → 输入 Tools: New Snippet 回车,自动生成带注释的骨架
  • 取消注释 <tabtrigger>log</tabtrigger>,改成你想要的,比如 doc 或 fn(别用 /**,含符号会解析失败)
  • 取消注释 <scope>source.python</scope>,替换成你查到的实际 scope
  • 在 <content></content> 里写注释模板,例如:
/**
 * ${1:description}
 * @param {${2:type}} ${3:param}
 * @returns {${4:type}}
 */
  • $1 是第一个跳转位,${2:type} 表示默认值为 type,可编辑;$0 必须显式写在末尾,否则光标卡死

保存路径和文件名有硬性要求

Sublime 只扫描特定目录下的 .sublime-snippet 文件,且文件名不能带空格、中文或多余点号。

  • 保存路径必须是 Packages/User/(可通过 Preferences → Browse Packages… 进入)
  • 文件名必须以 .sublime-snippet 结尾,例如 fn-doc.sublime-snippet,写成 fn-doc.snippet 或 fn-doc.sublime-snippet.txt 都不加载
  • 改完保存后无需重启 Sublime,但若之前已打开同名 snippet,要关掉重开才能热更新
  • 如果多个 snippet 共享同一 tabTrigger(如都设了 log),Sublime 只加载最先找到的那个,不会合并

想让 /** 自动出现在函数前?别依赖 snippet,用 DocBlockr

纯 snippet 做不了上下文感知——它不管光标前面有没有函数签名,只是机械插入。真要实现「在函数定义行上方敲 /** 回车就生成带参数的注释」,得用 DocBlockr 插件。

  • 通过 Package Control 安装 DocBlockr
  • 配置 Preferences → Package Settings → DocBlockr → Settings - User,开启 "auto_complete": true 和 "jsdoc_enable_types": true
  • 确保文件语法识别正确(.vue 文件里的 <script></script> 块需是 source.vue meta.script.js,不是 source.js)
  • DocBlockr 会自动提取函数参数名、类型(TS/JSdoc)、返回值,比手写 snippet 精准得多

真正容易被忽略的是 scope 的嵌套性:Vue 单文件组件、TSX、MDX 这些混合语法场景下,source.js 从来就不够用,必须用 Developer: Show Scope Name 实时看,而不是凭经验猜。

热门AI工具

更多
创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

WorkBuddy

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

豆包大模型

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

咔片AIPPT

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

DeepSeek

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

SoundView
SoundView Hot

SoundView是一款面向跨境电商的视频翻译、配音和本地化 AI 创作平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

160

2026.11.12

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

100

2026.11.12

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

100

2026.11.12

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

180

2026.11.06

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

140

2026.11.06

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

120

2026.11.06

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

120

2026.11.05

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

100

2026.11.05

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

120

2026.11.04

热门下载

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

精品课程

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

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