安裝appledoc
使用終端下載：
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh
直到出現(xiàn)這個畫面說明安裝成功
image.png
使用appledoc
最方便的方法就是在xcode中添加script
新建target
62671436F2C0F9E5E9CB0CC55D697839.jpg
BB0387477B5B7C162A3B2FA3F1AA873E.jpg
通過我們新增加的Run Script
添加一下腳本
#appledoc Xcode script
# Start constants
company="RANY";
companyID="com.RANY";
companyURL="http://ranyeee.top";
target="iphoneos";
#target="macosx";
outputPath="~/help";
# 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這里改一下API文檔輸出的路徑
--output "~/desktop/doc" \
--publish-docset \
--docset-platform-family "${target}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
"${PROJECT_DIR}"
添加好script之后 run 一下這個target
1B531CC204DD9FE98BA3156C140C0470.jpg
run 之后可以在output對應(yīng)的目錄下本地找到一個 html 文件
C291A89EBD5B46AA8BE438197AB52976.jpg
打開html文件就能看到漂亮的文檔了
E401AA0F7A30924AD29893F1C1AAB364.jpg
