appledoc相關内容彙總（非原創）介紹安裝使用

appledoc是在stackoverflow上被大家推薦的一個注釋工具。有幾個原因造成我比較喜歡它：

它預設生成的文檔風格和蘋果的官方文檔是一緻的，而doxygen需要另外配置。

appledoc就是用objective-c生成的，必要的時候調試和改動也比較友善。

可以生成docset，并且內建到xcode中。這一點是很贊的，相當于在源碼中按住option再單擊就可以調出相應方法的幫助。

appledoc源碼在github上，而doxygen在svn上。我個人比較偏激地認為比較活躍的開源項目都應該在github上。

相對于headerdoc，它沒有特殊的注釋要求，可以用/** */ 的格式，也可以相容/*! */的格式的注釋，并且生成的注釋有彙總頁面。

那麼簡單介紹一下如何安裝appledoc，安裝非常簡單，隻需要2步：

<a href="http://gentlebytes.com/appledoc/"></a>

<a href="http://webfrogs.me/feed/"></a>

為了使代碼便于閱讀，或者所寫的代碼需要提供給别人使用，這時就需要文檔了。而就我們程式員來說，最好的方式莫過于将文檔和源碼放在一起，在寫代碼時通過一定的規範編寫注釋，然後通過工具可以将專門的注釋部分抽取出來形成文檔，類似的，JAVA語言就自帶了javadoc指令。objective-c也中也有相應的工具，經過比較，最終選擇了appledoc來做注釋工具。appledoc的優點有不少，比如注釋風格自由，生成的文檔風格與蘋果官方文檔是一緻的，而且可以生成docset，并且內建到xcode中去，也就是說，可以在源碼中按住option鍵單擊來調出相應方法的幫助。

appdoc的安裝非常簡單，依次執行下面代碼即可。

我所用的注釋格式。注：appledoc的注釋内容中，支援基本markdown文法

類和類的成員變量說明：

函數注釋：

進入到工程根目錄，執行下面指令：

其中，XXX 的内容根據具體情況填寫，--output 後面接的是文檔輸出路徑，最後一個路徑，是需要生成文檔的源代碼所在路徑。

預設情況，在生成docset文檔後，appledoc會把生成的html以及中間檔案删除，然後将生成的docset文檔放置到xcode搜尋的文檔路徑下。若要儲存文檔生成過程的中間資料比如生成的html檔案，隻需在上面的指令中增加以下參數即可。

以下部分為原創:

如何生成文檔，最主要的是配置一個output的路徑和input的路徑；output路徑可以任意指定；input路徑是你需要生成appledoc的檔案們所在的檔案夾路徑.

輸入指令如上；其中/tmp/doc為output的設定路徑,/Core是input路徑；在實際操作時可以将路徑所在的檔案夾拖到終端裡，檔案夾的路徑就會被自動輸入到終端裡。

生成文檔後，在output路徑下是一個包含有實際檔案路徑的txt，通過它你就可以找到所生成的appledoc的全部内容。

未完待續