引言:
appledoc是一個可以幫你生成Objective-C代碼注釋的輔助工具,appledoc所生成的注釋API文檔與蘋果類庫的API文檔保持一緻.
這可以讓Xcode能夠識别出我們自己的API文檔.
參考:
1:Mac安裝Brew
<a href="http://blog.csdn.net/chenyi8888/article/details/7345113" target="_blank">http://blog.csdn.net/chenyi8888/article/details/7345113</a>
2:使用Objective-C的文檔生成工具:appledoc
<a href="http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/" target="_blank">http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/</a>
安裝:
appledoc的Github托管位址如下:
<a href="https://github.com/tomaz/appledoc" target="_blank">https://github.com/tomaz/appledoc</a>
此版使用Brew安裝appledoc
指令:sudo brew install appledoc
如果你事先沒有安裝Brew,那麼上面的指令肯定也就失效了.
安裝Brew使用如下指令:
指令:curl -LsSf http://github.com/mxcl/homebrew/tarball/master | sudo tar xvz -C/usr/local --strip 1
注意上面指令中紅色辨別的路徑.
你應該檢查一下,你是否有這個路徑,如下圖所示:
如果沒有,就手動建立一個以後,在執行安裝Brew的指令.
檢測一下Brew是否安裝成功.
指令:brew
如果出現一堆brew的使用說明,那麼說明已經安裝成功了.
接下來回到我們的appledoc 運作以下指令:
在執行指令中,還是有可能失敗.原因是指定的路徑沒有足夠的讀寫權限.
/usr/local/bin is not writable. You should change its permissions.
那麼去紅色辨別的路徑中為其設定讀寫權限
完成後,此時解除安裝appledoc. 此時appledoc安裝了一半,沒有完全安裝成功.
指令:brew uninstall appledoc
結束後,再重新執行一次安裝.
不出意外的話,應該就安裝成功了.
然後同樣的檢測一下,是否安裝成功,調出appledoc的幫助文檔.
指令:appledoc --help
使用:
通過以下指令來生成API文檔
注:以上指令中分别需要提供5個參數,分别是:
1:工程名稱
2:公司名稱
3:工程ID
4:生成結果輸出路徑
5:掃描哪個路徑下的類.
該指令會根據指定的路徑将所有的的類周遊一次,當生成成功以後,appledoc會建立一個文本檔案來記錄生成情況,這個檔案存放在上面指令中指定的--output.
執行上面的指令時,請確定删去了所有的換行符以後在執行.
生成的文檔會自動存放在Xcode預設的文檔目錄裡:
~/Library/Developer/Shared/Documentation/DocSets
不出意外的話,進入到目錄裡面就可以看到剛剛執行指令以後生成的文檔:
我們都知道按住option鍵位時,再點選某個方法或者屬性名稱
總結: