Sublime实现一键生成API文档 安装DocBlockr插件
Sublime Text 4 用户应弃用已停止维护的DocBlockr，改用兼容ST4的DoxyDoxygen；它支持多语言、LSP集成，需注意Jinja2模板语法、键位冲突及配置适配。 想在 Sublime Text 里一键生成 API 文档？这事儿听起来简单，但实际操作起来，不少朋友第一步就卡住
Sublime Text 4 用户应弃用已停止维护的DocBlockr，改用兼容ST4的DoxyDoxygen；它支持多语言、LSP集成，需注意Jinja2模板语法、键位冲突及配置适配。
想在 Sublime Text 里一键生成 API 文档？这事儿听起来简单，但实际操作起来，不少朋友第一步就卡住了。尤其是 Sublime Text 4 的用户，如果直接去安装 DocBlockr 插件，大概率会失败，或者生成一片空白注释。原因很简单，这个插件已经停止维护了，它底层的机制与 ST4 的新 API 和异步加载模式完全不兼容。即便是 Sublime Text 3 的用户，在 Python 3.8 及更高版本下，也可能因为 inspect.getargspec 被弃用而导致插件崩溃。所以，要实现这个功能，远不止“安装一个插件”那么简单，往往需要更换插件、调整配置，甚至重写模板。
ST4 用户别碰 DocBlockr，改用 DoxyDoxygen
为什么 DocBlockr 在 ST4 上行不通？看看它的官方仓库就知道了，明确标注着“unmaintained”（已停止维护）。安装后，按下那个经典的快捷键 Ctrl+Alt+D（Windows/Linux）或 Cmd+Alt+D（macOS），你会发现毫无反应。打开控制台，很可能会看到 AttributeError: 'NoneType' object has no attribute 'groups' 这样的报错。这可不是你的操作失误，而是插件的解析逻辑在新环境下直接崩溃了。
那么，正确的路径是什么？答案是 DoxyDoxygen。安装步骤倒是不复杂：
- 打开命令面板，输入
Package Control: Install Package，然后搜索DoxyDoxygen（注意拼写，别搜成 DocBlockr）。 - 安装完成后通常无需重启编辑器，但有一个关键点必须注意：确保当前文件的语法模式设置正确。看看编辑器右下角，应该显示为
Ja vaScript或Python等具体语言，而不能是Plain Text。 - 使用时，将光标放在函数定义行（比如
function getUser(id) {或def create_order(items):），然后按快捷键触发。这里有个小变化：不再是先输入/**再回车了。 - 如果你使用了 TypeScript 或 Babel 这类语法插件，它们可能会覆盖原生的语法高亮。如果发现插件不工作，可以尝试临时切换回原生的语言模式。
ST3 用户还能用 DocBlockr，但得卡准触发位置和语法
对于还在使用 Sublime Text 3 的用户，DocBlockr 理论上还能工作，但它的“脾气”可不小，对触发条件要求极为苛刻。它只在非常有限的场景下有效：函数必须用传统的 function 关键字声明（像 const fn = () => {} 这种箭头函数它无法识别）；函数的参数不能是解构形式（例如 ({ a, b }) 会导致参数漏掉）；最关键的是，光标必须严格位于函数正上方的空行——哪怕前面多了一个空格、一个制表符，甚至是一行注释，都会导致触发失败。
除此之外，还有几个常见的坑点：
- 输入
/**后，必须立刻按Enter键，按Tab键是没用的。 - 再次检查右下角的语言模式：如果 Ja vaScript 文件被错误地识别成了
HTML或Plain Text，DocBlockr会完全沉默。 - 如果按
Tab键没反应，可以去Preferences → Key Bindings里搜索docblockr，确认它的快捷键没有被 Emmet 或其他插件占用。 - 使用中文 Windows 系统的用户，如果发现生成的注释字段（如
@author）显示为乱码方块，需要检查一下fallback_encoding设置，确保其值为"UTF-8"。
自定义 API 文档模板时，变量语法和条件判断必须重写
当你需要定制符合团队规范的 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}。 - 对于 Ja vaScript 中的解构参数（例如
(options = { timeout: 5000 })），如果想正确提取出options.timeout这样的参数名，必须在配置中开启js_extract_destructured_params选项。
真正卡住人的从来不是“怎么装”，而是哪几处一错就全废
回顾整个过程，你会发现，真正让人头疼的往往不是安装步骤本身。安装完插件却发现没反应，90%的情况问题出在三个环节的衔接上：首先是语法模式不对，其次是触发位置不“干净”，最后是函数声明不符合插件的解析规则。对于 ST4 用户，还多了一层障碍：插件本身可能根本跑不起来。而在自定义模板时，最容易忽略的就是条件判断的包裹和变量语法的切换，可能看着配置生效了，但关键字段早已被默默跳过。这些环节就像一串链条，任何一个点出错，整个功能就失效了。不把这些点串联起来系统排查，安装多少遍也是徒劳。
Postman是一套面向API全生命周期的开发与测试平台，可在Mac上发送和调试多种协议请求，管理集合、环境及认证信息，并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用，提供个人免费方案。
Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境，集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。
Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境，基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。
Xcode 是苹果面向 Mac 提供的官方集成开发环境，将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中，适合开发与维护 iPhone、iPad、Mac、Apple Wa
JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境，可智能理解项目结构，提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。
PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境，可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。
JetBrains PyCharm 是面向 Python 开发者的集成开发环境，提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片，核心功能可免费使用。
IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境，重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具，并可借助插件扩展语言和框架支持。
Visual Studio Code 是微软提供的免费代码编辑器，支持 macOS，并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。
REAPER是Cockos开发的数字音频工作站，提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片，支持AU、VST、VST3、CLAP等插件格式，并提供高度可定制的工作流程。
Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站，提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具，并可与 Adobe Premiere 协同完成视频声音制作。
Pro Tools 是 Avid 推出的专业数字音频工作站，覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。
PixPix 是面向品牌、卖家和内容团队的在线 AI 图片视频创作平台，提供图视频 Agent、无限画布、图片生成、视频生成、自然语言编辑及商品套图、产品精修和带货视频等电商工具。
Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求，并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等
Docker Desktop 为 Windows 开发者提供集成式容器环境，内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件，可在本机完成镜像构建、容器运行、日志查看和资源管理。
Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境，以 IntelliJ IDEA 为基础，集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具，
WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索，并集成调试、测试、终端、Git 与常用前端工具，
PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境，提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序，
PyCharm 是 JetBrains 推出的 Python 集成开发环境，提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能，
JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境，提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目，
Visual Studio Code 是微软推出的免费代码编辑器，Windows 版集成智能补全、代码导航、调试、终端和版本控制，并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活，
REAPER 是 Cockos 推出的数字音频工作站，适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧，支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展，并提供完整功能的 60 天免费评估期。
Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站，提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理，
Pro Tools 是 Avid 推出的专业数字音频工作站，提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用，并提供免费入门版、订阅方案及永久授权选择。