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

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

雨萱姑娘_7635

雨萱姑娘_7635

发布时间:2026-06-26 08:21:56

|

125人浏览过

|

来源于php中文网

原创

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> 区域能触发 DocBlockr,但 <template> 区域可能完全没反应——这不是插件问题,是 scope 没覆盖到。

热门AI工具

更多
Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

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

咔片AIPPT

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

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

相关专题

更多
OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

0

2026.10.16

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

0

2026.10.16

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

0

2026.10.16

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

0

2026.10.16

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

20

2026.10.16

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

20

2026.10.15

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

20

2026.10.15

Vue.js 中 ref 和 reactive 的区别
Vue.js 中 ref 和 reactive 的区别

Vue.js中ref和reactive的区别专题汇集两种响应式API的定义、访问方式、对象解构、侦听与性能取舍等文章,帮助结合实际状态类型选择合适写法。

20

2026.10.15

热门下载

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

精品课程

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

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