技術文檔生成工具：appledoc

作項目通常都會要求寫技術文檔，特別是提供SDK或者基礎組件的。若是手寫這類技術文檔的話，工做量比編寫代碼也少不了多少。好比 Java 語言自己就自帶 javadoc 命令，能夠從源碼中抽取文檔。本篇咱們看一下OC中的一個相似工具：appledoc。

1.簡介

基於命令行的操做、使用方便，默認生成的文檔風格和蘋果的官方文檔是一致的，即docset，集成到xcode中就跟蘋果的官方文檔如出一轍，在源碼中按住option再單擊就能夠調出相應方法的幫助，固然也能夠生成html文檔。

總結一下，它具備下面這些特色：

• 它默認生成的文檔風格和蘋果的官方文檔是一致的；
• appledoc 是用 objective-c 生成的，必要的時候調試和改動也比較方便；
• 能夠生成 docset，而且集成到 Xcode 中，至關於在源碼中按住 option 再單擊就能夠調出相應方法的幫助；
• appledoc 源碼在 github 上；
• 沒有特殊的註釋要求，能夠用 /\*\* \*/ 的格式，也能夠兼容 /\*! \*/ 的格式的註釋，而且生成的註釋有彙總頁面。

2.安裝

安裝很簡單，按照下面的指令執行便可：

git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh

3.使用

使用 appledoc 時，只須要用以下命令便可：

/*
--project-name 工程名字     
--project-company 公司名字   
--company-id 公司ID    
--output 生成結果路徑
*/
appledoc --no-create-docset --output ../doc --project-name GofKit --project-company "Gof" --company-id "com.gof" .

appledoc 會掃描當前路徑下的全部文件，而後生成好文檔放到 doc 目錄下。

簡寫以下所示：

appledoc -o ./doc --project-name GofKit --project-company Gof .

編譯出的Docset默認會放在~/Library/Developer/Shared/Documentation/DocSets路徑下。 Docset格式，其實是一個bundle，裏面包含了一些xml和html。顯示包內容後就能夠查看和修改了。若是須要放到網站上，那單獨將html部分取出來就行。 

4.參考資料 

如何將本身項目的代碼文檔導出爲蘋果樣式