眾所周知，程序員最討厭的兩件事：1辰斋、接手的項(xiàng)目沒(méi)有注釋2策州、給自己的項(xiàng)目添加注釋。一般一個(gè)項(xiàng)目上線后宫仗，公司都要求項(xiàng)目代碼進(jìn)行詳細(xì)注釋和到處文檔够挂，然后才封版，所以就用到了今天我整理的這篇文章藕夫，使用appledoc自動(dòng)生成項(xiàng)目文檔下硕。
appdoc的使用有一個(gè)前提，注釋要符合標(biāo)準(zhǔn)汁胆，值得慶幸的是Xcode8之后，Xcode已經(jīng)集成了注釋插件霜幼，點(diǎn)擊command+option+/即可嫩码，此處不做過(guò)多介紹，效果如下：
安裝appledoc
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh
安裝完成之后罪既，驗(yàn)證一下是否安裝成功
appledoc --version
生成文檔
生成文檔有兩種方法：
一铸题、使用終端命令生成：
appledoc --project-name 工程名稱 --project-company 公司名稱 ./
二、使用targets集成到項(xiàng)目中：
腳本文件如下：
#appledoc Xcode script
# Start constants
company="公司名稱";
companyID="com.公司id";
companyURL="http://公司網(wǎng)址";
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}"
著作權(quán)歸作者所有琢感。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán)丢间，非商業(yè)轉(zhuǎn)載請(qǐng)注明出處。
步驟依次如下：
然后進(jìn)行編譯饮六，編譯成功后文檔就自動(dòng)生成了，在此苛蒲，如果編譯的時(shí)候有報(bào)錯(cuò)卤橄，退出Xcode，再打開(kāi)clean后重新編譯即可臂外。
文檔路徑
生成的文檔會(huì)默認(rèn)放在/Users/用戶名/Library/Developer/Shared/Documentation/DocSets路徑下
閱讀在Xcode --> Window-->Documentation And API Reference 里面找啦窟扑，快捷鍵就是command+shift+0
效果圖如下：
