macOS 如何在 Xcode 中将项目代码导出为离线文档供查阅

<p>Xcode 可通过 DocC 工具将带规范注释的 Swift/Objective-C 代码一键导出为可离线浏览的 .doccarchive 文档；需确保注释符合 DocC 语法（如 /// 或 /* /），编译成功后在 Documentation 查看器中 Export，双击即可用浏览器打开，支持搜索、跳转与深色模式。</p>

Xcode 可以将项目中带规范注释的代码自动生成结构化离线文档，无需联网即可查阅。关键在于用 DocC 工具生成 .doccarchive 文件，它自带网页界面，双击就能在浏览器里打开浏览。

确保代码已有 DocC 兼容注释

DocC 识别的是 Swift 或 Objective-C 中符合其语法的文档注释，比如：

1. Swift：用 /// 或 /** */ 写，支持 @param、@returns、@see 等标记；
2. Objective-C：头文件（.h）里用 /** */ 注释，类、方法、属性都需明确标注；

   没写注释或格式不规范，导出后内容会为空或不完整。

在 Xcode 中一键导出文档归档

1. 打开项目后，确保已成功编译（Build 通过），DocC 才能解析符号；
2. 点击菜单栏 Window → Documentation（或按 ⌘⇧0），进入文档查看器；
3. 在左侧“Workspace Documentation”区域，找到你项目的文档条目（名称通常和 target 一致）；
4. 将鼠标悬停在该条目上，点击出现的 ⋯（More）按钮 → Export；
5. 选择保存位置（如桌面或项目根目录），确认导出，得到一个 .doccarchive 后缀的文件夹。

离线查阅方式

1. 直接双击 .doccarchive 文件，系统会用默认浏览器打开交互式文档 ；
2. 支持全文搜索、跳转符号、侧边导航、深色模式，体验接近 Apple 最新文档；
3. 也可复制整个 .doccarchive 文件夹发给其他开发者，他们无需 Xcode 即可本地浏览。

补充说明

1. 不依赖 Xcode 运行时环境，导出后删掉项目或换电脑都不影响查阅；
2. 若需集成进 CI 流程，可用命令行：

   xcodebuild docbuild -scheme "YourScheme" -destination "generic/platform=iOS"

   输出路径默认在 ~/Library/Developer/Xcode/DerivedData/.../Products/usr/local/share/docc/，可配合 --output 指定位置。