使用 appledoc 生成 API 文档

Mr. X

2017-09-09

appledoc 是个十分强大的工具，能生成和 Apple 一个风格的文档，功能齐全，使用方便，还可以直接编译成 docset 安装进 Xcode。

安装

git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh

验证

appledoc --version

使用

你可以直接通过终端命令去生成，不过我更喜欢做成 Xcode 编译脚本，步骤如下：

选中你的工程，点击 Add Target 按钮，选择 Other -> Aggregate 模板新建
点击 Add Build Phase 按钮，添加一个 Run Script
把下面的模板代码复制进去，把前几行参数改成你自己的
在 Xcode 左上角选择这个新建的 Target，然后点击 build
文档就会编译好并且自动安装进 Xcode 了（重启 Xcode 生效）

#appledoc Xcode script
# Start constants
company="xaoxuu";
companyID="com.xaoxuu";
companyURL="http://xaoxuu.com";
target="iphoneos";
#target="macosx";
outputPath="${SRCROOT}/docs/appledoc";
# End constants
/usr/local/bin/appledoc --project-name "${PROJECT_NAME}" --project-company "${company}" --company-id "${companyID}" --docset-atom-filename "${company}.atom" --docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" --docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" --docset-fallback-url "${companyURL}/${company}" --output "${outputPath}" --publish-docset --docset-platform-family "${target}" --logformat xcode --keep-intermediate-files --no-repeat-first-par --no-warn-invalid-crossref --exit-threshold 2 "${PROJECT_DIR}/AXKit"

open "${SRCROOT}/docs/appledoc/html/index.html"