最近有點(diǎn)小忙，好久沒(méi)有寫(xiě)文章了。今天我們聊一聊Objective-C技術(shù)文檔。
獨(dú)立開(kāi)發(fā)可以不管這些，不過(guò)做項(xiàng)目的人多了，就需要文檔了，方便其他人員查看使用。手工寫(xiě)文檔是一件苦差事，經(jīng)過(guò)查找發(fā)現(xiàn)了從源碼中抽取注釋生成文檔的專(zhuān)用工具：
[doxygen](http://www.stack.nl/~dimitri/doxygen/index.html)：適于生成html文檔與pdf文檔。 支持的語(yǔ)言多，可以配置的地方也比較多。默認(rèn)生成的風(fēng)格與蘋(píng)果的風(fēng)格不一致。
[headdoc](http://developer.apple.com/opensource/tools/headerdoc.html) ：是 Xcode 自帶的文檔生成工具。在安裝完 Xcode 后，就可以用命令行來(lái)生成對(duì)應(yīng)的文檔。不過(guò)它只生成以/*! */
的格式的注釋。不兼容 /** */
格式的注釋
[appledoc](http://gentlebytes.com/appledoc/): [Github地址](https://github.com/tomaz/appledoc) ，適于生成html文檔和xcode幫助文檔（docset）。可以兼容 /** */
格式，也可以兼容 /*! */
格式的注釋。
這些都是前人總結(jié)的特點(diǎn)我也沒(méi)有一個(gè)個(gè)嘗試，我直接選取了 appledoc,下面是安裝步驟和使用步驟。
安裝
兩種方式：
1 如果你裝了homebrew，打開(kāi)終端，輸入以下命令：
brew install appledoc
第一次用的這種方式，安裝雖然成功了但是去找不到生成的html文件，后來(lái)找到了文件打開(kāi)之后里面的內(nèi)容卻不對(duì)，所以如果有朋友看到后可以告訴我怎么回事，先謝謝了~
2 打開(kāi)終端，輸入以下命令：
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
安裝成功會(huì)出現(xiàn)
使用
首先創(chuàng)建一個(gè)項(xiàng)目appledoc,為了便于演示，寫(xiě)幾個(gè)注釋?zhuān)?/p>
打開(kāi)終端進(jìn)入項(xiàng)目目錄
使用命令創(chuàng)建
//格式：appledoc --project-name 你的項(xiàng)目名稱(chēng) --project-company 你的公司名稱(chēng) ./
appledoc --project-name appledoc --project-company kt ./
之后打開(kāi)你的工程文件會(huì)看到：
這里的路徑就是生成文檔的路徑了，一般是html格式，順著路徑找下去如圖：
右鍵顯示包內(nèi)容
這個(gè)html文件就是你需要的了打開(kāi)如下:
此時(shí)在Xcode中也幫你生成了文檔：
退出Xcode，重新打開(kāi)工程選擇在 Help—Documentation and API Reference中也可以看到
當(dāng)然如果你只是想生成一分html文檔的話就只要用終端進(jìn)入工程目錄之后執(zhí)行下列命令：
//加入--no-create-docset
appledoc --no-create-docset --project-name appledoc --project-company kt ./
雖然有提示但是不影響使用(額，其實(shí)是不知道怎么解決，哈哈??)
在工程目錄中會(huì)發(fā)現(xiàn)多了一個(gè)
點(diǎn)擊打開(kāi)發(fā)現(xiàn)和剛才的那個(gè)一樣哎??
這個(gè)就是你的技術(shù)文檔了，方便他人查看使用。
希望對(duì)各位有所幫助吧，別忘了喜歡單贊收藏轉(zhuǎn)發(fā)~~~
