Sublime中一键生成代码注释文档的绝招

雨萱姑娘_7635

雨萱姑娘_7635

2026-06-26

125人浏览

原创

docblockr 插件需安装社区维护分支 sublimetext-docblockr,语法模式须为支持语言且光标位于函数定义行或其正上方空行;默认无类型占位符,需手动配置 jsdoc_template;列模式是快捷键失效时的兜底方案。

sublime中一键生成代码注释文档的绝招

DocBlockr 插件装不对,/** + Enter 就是废的

装错版本是失效第一原因:搜 DocBlockr 容易装到已停更的旧版(作者不是 nikhilm)。必须用 Package Control 装社区维护分支——按 Ctrl+Shift+P(Mac 为 Cmd+Shift+P),输 Package Control: Install Package,搜到 GitHub 仓库名 sublimetext-docblockr 才对。装完建议重启 Sublime,否则部分版本不加载。

光标位置和语法模式,缺一不可

/** + Enter 不触发,90% 是这两项没配准:

  • 右下角语法必须是 JavaScript、Python、PHP 等支持语言,不能是 Plain Text(点它手动切)
  • 光标必须在函数定义行(如 function foo() 或 def bar():)任意位置,或其正上方空行;在函数体里、变量行、已有注释行都不行
  • Enter 是触发键,Tab 只用于生成后跳字段,别搞混
  • 检查是否有插件(如 Emmet)劫持了 Enter 行为,可临时禁用验证

生成的注释没类型占位符?得手动配模板

默认生成的 @param 后面是空的,不会自动填 {number} 或 {string}。要加类型提示,必须改用户配置:

Sublime Text Build Linux版
Sublime Text Build Linux版

Sublime Text Linux x86-64 deb 安装包。官方也提供 rpm、tar.xz 和软件源安装方式。

下载
  • 进 Preferences → Package Settings → DocBlockr → Settings – User
  • 加一行:"jsdoc_template": "/**\n * $1\n * @param {$2} $3\n * @return {$4}\n */"
  • 保存后,/** + Enter 就会带占位符,光标停在描述处,Tab 可顺次跳转

快捷键冲突或语法不支持时,列模式才是真兜底

当 Ctrl+/ 失效、Ctrl+Shift+/ 不包裹、甚至 DocBlockr 完全不响应,别折腾配置——直接上列模式:

  • Windows/Linux:按住 Alt,鼠标从第一行目标列拖到最后一行对应列
  • macOS:按住 Option,同样操作
  • 松手后输入 // 或 #,所有行同一列位置同步出现
  • 这招不依赖语法识别、不看插件状态、不care缩进是否对齐,专治各种“注释失灵”

真正容易被忽略的是作用域(scope)匹配机制:Sublime 不看文件后缀,而是看光标所在位置的实际语法 scope。比如 .vue 文件里 <script></script> 区域能触发 DocBlockr,但 <template></template> 区域可能完全没反应——这不是插件问题,是 scope 没覆盖到。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

sublime text sublime

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

2026.10.08

0

20

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

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

2026.09.30

120

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

100

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

80

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

80

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

100

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

300

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

180

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

140

15

热门下载

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

精品课程

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