一句话Mr.Docs 是面向现代 C++ 的文档生成工具,可将代码旁的文档注释生成结构化参考页,并支持 AsciiDoc、HTML、XML 等输出。
定价未说明
适合谁C++ 库/框架开发者、维护大型 C++ 代码库的团队、需要从源码生成 API 参考文档的开源或工程团队
核心功能从 C++ 声明旁的文档注释生成参考文档准确建模现代 C++ 语义支持 AsciiDoc、HTML、XML 输出可通过 generator plugins 扩展输出支持高度可配置的输出格式、主题、符号选择支持 Windows、Linux、macOS 二进制包提供从源码安装的 bootstrap 脚本
功能与用途将 C++ 声明旁的文档注释转换为权威参考页面,生成包含 synopsis、description、parameters、returns、exceptions、template parameters 等结构化内容的文档。
支持语言/框架明确面向现代 C++;正文提到可理解 overload sets、concepts and constraints、deduced return types、aliases、constants、SFINAE、inherited and hidden members、niebloids、函数对象等 C++ 特性。
开源还是闭源正文出现 GitHub 克隆地址 https://www.github.com/cppalliance/mrdocs.git 和 Contribute、License 导航,但未在抓取正文中明确许可证类型。
自托管选项可下载 Windows、Linux、macOS 二进制包,也可通过源码 bootstrap 脚本安装;生成的 HTML、AsciiDoc、XML 可自行托管。
定价未说明定价或收费模式。
API/SDK未提及传统 API/SDK;支持通过自定义 generator plugins 扩展输出生成器。
集成与生态源码安装脚本可自动处理 LLVM、Clang、JerryScript、Lua、Boost headers、libxml2;构建基于 CMake,并提供 CI/cache 相关 bootstrap 选项。
文档质量抓取内容包含 Features、Installation、Getting Started、Configuration File、Documenting the Code、Addons、Generators、Extensions、Design Notes、Library Reference、Contribute 等章节导航;安装页列出版本、平台包、bootstrap 参数、CI 用法,细节较充分。
中国访问未知
适用场景为 C++ 库生成 API 参考文档;将注释中的参数、返回值、异常、复杂度等信息整理为结构化页面;在 CI 中从源码构建文档;输出 HTML/AsciiDoc/XML 供网站或其他文档系统使用。
同类Doxygen、Sphinx+Breathe、MkDocs、DocFX