Sublime实现一键生成API文档安装DocBlockr插件-sublime-PHP中文网

sublime text 4 用户应弃用已停止维护的docblockr，改用兼容st4的doxydoxygen；它支持多语言、lsp集成，需注意jinja2模板语法、键位冲突及配置适配。

sublime实现一键生成api文档安装docblockr插件

Sublime Text 4 用户直接装 DocBlockr 基本会失败或生成空注释，它已停止维护，且不兼容 ST4 的 API 和异步加载机制；ST3 用户也需注意 Python 3.8+ 下 inspect.getargspec 被弃用导致崩溃。真要一键生成 API 文档，得换插件、调配置、改模板，不是装完就完事。

ST4 用户别碰 DocBlockr，改用 `DoxyDoxygen`

官方仓库明确标为 “unmaintained”，在 ST4 上安装后按 Ctrl+Alt+D（Windows/Linux）或 Cmd+Alt+D（macOS）没反应，控制台报 AttributeError: 'NoneType' object has no attribute 'groups' 是典型症状。这不是你操作错，是插件底层解析逻辑在新 API 下直接崩了。

打开命令面板 → Package Control: Install Package → 搜 DoxyDoxygen（注意拼写，不是 DocBlockr）
装完无需重启，但必须确保当前文件语法模式正确（右下角显示 JavaScript 或 Python，不能是 Plain Text）
光标放在函数定义行（如 function getUser(id) { 或 def create_order(items):），按快捷键触发，不是敲 /** 回车
若用 TypeScript 或 Babel 插件，可能覆盖语法高亮，临时切回原生模式再试

ST3 用户还能用 `DocBlockr`，但得卡准触发位置和语法

它只在极有限条件下工作：函数必须用 function 关键字声明（const fn = () => {} 不识别），参数不能是解构（({ a, b }) 会漏掉），且光标必须严格位于函数正上方的空行——前面有空格、制表符、甚至注释都不行。

飞桨PaddlePaddle

飞桨PaddlePaddle是百度推出的开源深度学习平台。

下载

输入 /** 后立刻按 Enter（不是 Tab），否则不展开
检查右下角语言模式：JS 文件被识别成 HTML 或 Plain Text 时，DocBlockr 完全静默
如果按 Tab 没反应，去 Preferences → Key Bindings 搜 docblockr，确认快捷键没被 Emmet 或其他插件劫持
中文 Windows 用户若见乱码字段（如 @author 显示方块），检查 fallback_encoding 是否设为 "UTF-8"

自定义 API 文档模板时，变量语法和条件判断必须重写

DoxyDoxygen 用 Jinja2 语法，和 DocBlockr 的 ${1:description} 完全不兼容。直接复制旧模板会导致字段消失、整行跳过，甚至模板解析失败。

@param 循环必须写成：{% for param in params %}@param {param.type} {param.name}{% endfor %}
想让 @return 在无返回值时也显示，得包一层判断：{% if return_type %}@return {return_type}{% endif %}
模板里所有变量去掉了 $ 和序号，比如 {description}，不是 ${1:description}
JS 解构参数（如 (options = { timeout: 5000 })）要提取 options.timeout，必须开启配置项 js_extract_destructured_params