0

0

sublime如何安装DocBlockr插件_Sublime自动生成函数注释【插件】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-02-10 14:16:59

|

455人浏览过

|

来源于php中文网

原创

DocBlockr 在 Sublime Text 4 不能直接使用,需改用社区维护的 DoxyDoxygen:安装后重启,支持多语言注释生成,可配置为 JSDoc 换行格式,但类型推导依赖正则、对 TS 解构/箭头函数识别有限。

sublime如何安装docblockr插件_sublime自动生成函数注释【插件】

DocBlockr 在 Sublime Text 4 还能用吗

不能直接用。原版 DocBlockr 已停止维护,Sublime Text 4 默认禁用未签名插件,而旧版 DocBlockr 没有签名,安装后基本不响应快捷键或自动补全。

实际可用的是社区维护的分支:DocBlockr-React(支持 JS/TS/JSX)或更通用的 TrailingSpaces 配合手动优化——但真正稳定、适配 ST4 的替代品是 SublimeJsPrettier + ESLint 链路里自带的注释提示,或者干脆换用 DoxyDoxygen

  • 别在 Package Control 里搜 DocBlockr,它会装上老版本,白忙活
  • ST4 启动时若弹出 “unsigned plugin disabled”,八成就是它
  • 如果项目用 TypeScript,DoxyDoxygen@param 类型推导更准,比硬套 JS 的 DocBlockr 更靠谱

用 Package Control 安装 DoxyDoxygen 的实操步骤

DoxyDoxygen 是目前 ST4 下最接近原 DocBlockr 体验的替代:支持 C/C++/Python/JavaScript/TypeScript,按 Ctrl+Alt+D(Win/Linux)或 Cmd+Alt+D(macOS)生成块注释,光标停在函数名上就能自动提取参数。

  • 打开 Command Palette(Ctrl+Shift+P),输 Package Control: Install Package 回车
  • DoxyDoxygen,选中安装(不是 DocBlockr,拼写差一个字母都不行)
  • 装完重启 Sublime(不重启,快捷键不生效)
  • 在 JS 文件里写个函数,把光标放在函数名上,按 Ctrl+Alt+D,看是否生成带 @param 的注释块

注意:默认注释风格是 Doxygen 风格(/** */),如需 JSDoc 风格(/**\n * */ 换行格式),要改配置——见下一条。

DoxyDoxygen 怎么改成 JSDoc 格式输出

原生 DoxyDoxygen 默认用紧凑单行 /** @brief ... */,和主流编辑器(VS Code)、TypeScript 类型检查工具预期的换行 JSDoc 不一致,会导致 @returns 被忽略、IDE 不识别类型。

VisionStory
VisionStory

AI视频、直播、视频播客

下载
  • 菜单栏选 Preferences → Package Settings → DoxyDoxygen → Settings
  • 在右侧用户设置里加这段:
{
    "languages": {
        "javascript": {
            "template": "/**\n * ${cursor}\n */"
        },
        "typescript": {
            "template": "/**\n * ${cursor}\n */"
        }
    }
}

保存后,再按 Ctrl+Alt+D 就会生成标准换行块;${cursor} 是光标占位符,可替换成 @param {string} name - \n@returns {number} 等固定模板,但建议留空,靠后续 Tab 键跳转填充更灵活。

为什么生成的 @param 类型经常为空或错乱

因为 DoxyDoxygen 不解析 AST,只靠正则匹配函数签名——遇到解构参数、箭头函数、TS 类型注解(如 (name: string))就容易漏掉或误判。

  • 普通 function 声明(function foo(a, b) {)识别最稳
  • 箭头函数(const foo = (a, b) => {})需确保等号和括号间无换行,否则正则断掉
  • TS 参数带类型((a: string, b?: number))会被当成普通字符串,@param 里不会出现 {string}
  • 解构参数(({ id, name }))基本无法识别,建议手动补全或改用 JSDoc 插件 Document This(但后者仅支持 VS Code)

真要强类型支持,别指望 Sublime 的注释插件——它定位就是轻量补全,不是类型系统。复杂项目该切 VS Code + ESDocTypeDoc 流程。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

668

2023.08.02

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

541

2023.09.20

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

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

465

2023.08.03

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

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

213

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1543

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

636

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

821

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

792

2024.04.29

包子漫画网页版入口与全集阅读指南_正版免费漫画快速访问方法
包子漫画网页版入口与全集阅读指南_正版免费漫画快速访问方法

本专题汇总了包子漫画官网和网页版入口,提供最新章节抢先看方法、正版免费阅读指南,以及稳定访问方式,帮助用户快速直达包子漫画页面,无广告畅享全集漫画内容。

44

2026.02.10

热门下载

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

精品课程

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

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