用途:DocBox 自动解析 BoxLang 或 CFML 源码,读取 JavaDoc 风格 /** ... */ 注释、类/属性/函数元数据及继承关系,生成可浏览的 API 文档。
主要能力:支持多种输出策略——HTML(default 为 SPA,含搜索、方法标签、深色模式;frames 为传统三栏框架)、JSON(供工具与 CI 集成)、UML/XMI(供 UML 工具)、CommandBox 命令文档;可一次运行添加多个策略;excludes 为正则,按类名与路径跳过匹配项;可继承 AbstractTemplateStrategy 自定义输出格式。
使用方式:安装可用 box install bx-docbox、install-bx-module bx-docbox、box install commandbox-docbox --saveDev 或 box install docbox --saveDev。CLI 示例:boxlang module:docbox --source=/path/to/code --mapping=myapp --output-dir=/docs,可加 --project-title、--excludes、--theme=frames、--mappings:name=path,--help 查看全部选项。编程式用 new docbox.DocBox().addStrategy(...).generate(source=..., mapping=..., excludes=...),source 可为多目录数组。
适用场景:为 BoxLang/CFML 项目生成 API 站点、机器可读文档或 UML 图,并可在 GitHub Actions 等 CI 中生成并上传文档产物。
限制:需源码含文档注释;outputDir 需为绝对路径(用 expandPath());excludes 需覆盖测试与构建目录;具体版本、收费与平台支持资料未提供。