1. 簡單說一下背景和自己感受
背景：
項目好像突然黃了讳推，公司讓詳細(xì)寫項目代碼的注釋并且導(dǎo)出文檔析砸，弄完之后就要封版。
說實話：聽到這個消息之后心里還是很擔(dān)心的垮庐，因為我知道公司不可能養(yǎng)閑人松邪，我手上的項目本來年后就沒有什么起色，加上突然來了這樣的一個‘噩耗’哨查，頓時就知道后面肯定沒好事
我知道公司不會養(yǎng)閑人逗抑，所以在這幾天項目閑下來的日子里，忐忑過,也想到了項目可能面臨的種種，當(dāng)然也包括自己所可能受到的種種影響邮府。但是畢竟我們只是聽上面安排的一線開發(fā)人員浙于，做不了項目大方向的主，只能服從安排挟纱，所以不管心情如何還是要把工作完成羞酗，只是想記錄一下心情和工作中遇到的問題。
2. Xcode代碼導(dǎo)出注釋實踐
Xcode導(dǎo)出代碼文檔的方式一共有三種紊服，Doxygen, headdoc 和 appledoc 檀轨。以下是三者官網(wǎng)鏈接：
3. 介紹appledoc
由于我查到的資料顯示appledoc最受歡迎，并且生成的文檔風(fēng)格和apple一致欺嗤，非常滿足我的需求参萄，故我使用的也是appledoc，有興趣的同學(xué)可以自行進(jìn)入官網(wǎng)或網(wǎng)頁自行查詢煎饼。
appledoc的幾點(diǎn)優(yōu)點(diǎn)：
- 它默認(rèn)生成的文檔風(fēng)格和蘋果的官方文檔是一致的讹挎，無需額外配置。
- appledoc 就是用 objective-c 生成的吆玖，必要的時候調(diào)試和改動也比較方便筒溃。
- 可以生成 docset，并且集成到 Xcode 中沾乘。這一點(diǎn)是很贊的怜奖，相當(dāng)于在源碼中按住 option 再單擊就可以調(diào)出相應(yīng)方法的幫助。
4.安裝appledoc
安裝appledoc步驟非常簡單翅阵，只需兩步：
- 終端中clone項目到本地
- 運(yùn)行安裝腳本
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
驗證是否安裝成功
appledoc --version
我這邊版本如下：
5.使用
appledoc的使用非常簡單歪玲，2步即可：
- 在終端中進(jìn)入要導(dǎo)出文檔的目錄下
- 輸入如下命令
appledoc --project-name "XYBannerView" --project-company "xiaoyouPrince" ./
注意：
- XYBannerView：是你自己的項目名（隨便寫也可以）
- xiaoyouPrince： 是項目對應(yīng)的公司名（隨便寫也可以）
-
./導(dǎo)出到當(dāng)前路徑的一個參數(shù)，前面要有空格掷匠！
appledoc 會掃描當(dāng)前路徑下的所有文件滥崩，然后生成好文檔放到 doc 目錄下。你也可以用 appledoc --help 查看所有可用的參數(shù)讹语。
基本上使用起來還是比較方便的钙皮，詳細(xì)的信息可以查看官方的文檔：http://gentlebytes.com/appledoc/
6.我遇到的問題：Command /bin/sh failed with exit code 250
報錯信息：
Command /bin/sh failed with exit code 250
如圖：（遇到的同學(xué)肯定印象深刻，并且還很難找到答案募强，這也是我為什么想寫這個文章的原因）
我從網(wǎng)上找到答案的主要意思（有很多是相關(guān)的株灸，具體的答案真沒找到）：
- 和 enum 和 NS_ENUM 類型的支持有關(guān)（這個在作者的更新中已經(jīng)修改好像）
- 和 Pods 中的三方庫等資源有關(guān)。由于項目大很多東西是不支持的
- 警告一般是項目中的注釋擎值，缺少參數(shù)或格式問題（三方庫中尤其明顯）
7. 解決方法
說了這么多慌烧，下面說一下解決方法：
由于三方庫和一些資源有問題，那就跳過三方（Pods和一些手動導(dǎo)入的）鸠儿，進(jìn)入下一層目錄執(zhí)行命令
appledoc --project-name "XYBannerView" --project-company "xiaoyouPrince" ./
這就對于項目中文件結(jié)構(gòu)的分層很重要屹蚊，我們自己的代碼和項目中引用的三方代碼需要分開
雖然還是有些警告和小問題厕氨，但是可以導(dǎo)出來了。
我有些問題并沒有研究很深入汹粤，希望有研究的朋友能不吝賜教命斧，多多分享！
