Doxygen、Jazzy和VVDocumenter-Xcode是macOS下主流代码文档工具：Doxygen多语言通用，支持类图生成；Jazzy专精Swift/Objective-C，产出苹果风格Web文档；VVDocumenter-Xcode为Xcode插件，实时生成兼容Doxygen的注释模板。
macos 下生成代码文档，主流工具有 doxygen、jazzy 和 vvdocumenter-xcode，各自适配不同语言和场景。选对工具 + 正确安装 + 基础配置，就能快速产出可读性强的 api 文档。
Doxygen：多语言通用型文档工具
适合 C/C++、Objective-C、Java、Python 等带注释规范的项目，输出 HTML / PDF / XML 等格式，支持调用 Graphviz 自动生成类图、调用图。
- 安装方式（推荐 Homebrew）：
brew install doxygen graphviz
验证是否成功：doxygen -v和dot -V都应有版本输出 - 初始化配置：
在项目根目录运行doxygen -g，生成默认配置文件Doxyfile - 关键配置项建议修改：
– PROJECT_NAME = 你的项目名
– INPUT = 指向源码目录（如src/ include/）
– RECURSIVE = YES（递归扫描子目录）
– GENERATE_HTML = YES
– CALL_GRAPH 和 CALLER_GRAPH = YES（需已装 graphviz） - 生成文档：
doxygen Doxyfile，完成后打开html/index.html即可浏览
Jazzy：专为 Swift 和 Objective-C 设计
由苹果生态开发者广泛采用，能直接解析 Xcode 构建产物，生成美观、响应式的 Web 文档，天然支持 Swift Markdown 注释语法。
- 依赖前提：
– 已安装 Xcode Command Line Tools（xcode-select --install）
– Ruby ≥ 2.5（macOS 自带 Ruby 一般够用；若需升级，建议用rbenv或homebrew安装） - 安装 Jazzy：
sudo gem install jazzy
（如遇权限问题，可改用gem install --user-install jazzy，并把~/.gem/bin加入 PATH） - 基础使用：
在项目根目录执行：jazzy --swift-build-tool xcodebuild --build-tool-arguments -scheme,YourScheme,-sdk,macosx
或更简洁地：创建jazzy.yml配置文件后直接运行jazzy - 注意：Jazzy 默认只处理 public 和 open 声明，如需包含 internal 成员，添加
--include-deprecated或调整min_acl配置
VVDocumenter-Xcode：Xcode 内嵌式注释助手
不生成独立文档网站，而是在 Xcode 编辑器中实时补全函数/方法的注释模板，提升写文档效率，与 Doxygen 或 appledoc 兼容。
- 安装方式（推荐 Alcatraz，但注意其已停止维护；现可用 Xcode 插件替代方案）：
– 手动构建：克隆仓库 → 用 Xcode 打开项目 → 选择VVDocumenter-Xcodetarget → ⌘B 编译 → 重启 Xcode
– 插件路径：~/Library/Application Support/Developer/Shared/Xcode/Plug-ins - 启用后，在 Swift 或 Objective-C 方法上方输入
///并回车，自动填充参数、返回值、讨论等字段 - 支持快捷键自定义（Xcode → Settings → Key Bindings），例如绑定到
Ctrl+Option+Cmd+D - 生成的注释格式符合 Doxygen 规范，后续可直接被 Doxygen 或 Jazzy 解析
三种工具并不互斥：日常开发用 VVDocumenter 写规范注释，Swift 项目用 Jazzy 出 API 网站，混合语言老项目用 Doxygen 统一覆盖。关键是先写好注释，再选对工具链跑起来。
