一、安裝
1歧蕉、github上下載地址:https://github.com/tomaz/appledoc.git
2顽腾、下載之后,終端執(zhí)行 cd /users/你的位置/desktop/appledoc 進(jìn)入appledoc文件
3副砍、終端執(zhí)行 sudo sh install-appledoc.sh 進(jìn)入安裝,安裝成功會有success提示 ?
二庄岖、使用
1豁翎、在工程里新建一個target,選擇 Other 中的 Aggregate隅忿。
2心剥、在新建的target里選擇Build Phases,添加Run Script?
3、將下面這段代碼復(fù)制到 Run Script里即可背桐,前五個參數(shù)改成你自己的优烧。
```
#appledoc Xcode script
# Start constants
company="abc";? ? //公司名
companyID="com.abc";? ? //公司id
companyURL="http://abc.com";? //公司url
target="iphoneos";? ? //操作系統(tǒng)
#target="macosx";
outputPath="~/desktop/xtmm/document";? ? //存放的位置
# 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}"
```
4、選擇創(chuàng)建的這個target,build一下链峭,然后完全退出再重新打開就可以生成文檔了匙隔。
注意:build的時候會報錯 ?Command /bin/sh failed with exit code 2,但是一樣會生成文檔熏版,不知道是bug還是為什么....