1. 下載appledoc對應(yīng)的有兩種方式
1. 直接下載對應(yīng)的工程,或者用guthub客戶端下載
2.使用終端下載appledoc
最后安裝
cd到對應(yīng)的appledoc目錄下
sudo sh install-appledoc.sh
生成文檔
在終端cd到對應(yīng)的工程的目錄下,用如下命令:
appledoc --project-name="projectName" --project-version="3.1.0" --project-company="companyName" --company-id="companyID" --output="./" --docset-install-path="./" .
注意:最后一定要加一個空格和點
上面的projectName和companyName必須寫(用這種方法不必再寫腳本了)companyID填寫對應(yīng)的BundleID就可以了。
最后輸出的./這個可以自己寫對應(yīng)的路徑。
或者:
appledoc --project-name 你的項目名稱 --project-company 你的公司名稱 ./
注釋
注釋使用headerDoc就可以了,或者vvdoccument也可以
最好參考開源的大V寫的注釋格式。
生成的文件如下
111.png
然后右鍵點擊.docset文件顯示包內(nèi)容
1111.png
11111.png
對應(yīng)的在Xcode里面寫成的注釋就行了
2. 想要集成到Xcode中去需要添加aggregate
File->New->Target 出現(xiàn)下面的圖
Aggregate.png
add Run Script.png
runScript.png
將下面的腳本添加到runScript中去,然后選擇target編譯就可以在項目中使用了
#appledoc Xcode script
# Start constants
company="ACME";
companyID="com.ACME";
companyURL="http://ACME.com";
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 "${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}"
謝謝那些開源的作者的幫助。
參考資料
下面這個有集成appledoc到Xcode中
http://www.cocoachina.com/ios/20161125/18183.html