[技巧]使用Xcode集成的HeaderDoc自動生成注釋和開發文檔

Doxygen本來是一個很好的工具，可是我感覺在mac系統下，如果用doxygen最後生成的CHM文件感覺就不是那麼恰當，應為本身CHM是微軟的產品，蘋果系統上並不是很通用，很經常出現文件亂碼的情況。這時CHM就比不過PDF和RTF文件。其實直接的html文件也不錯。

那在mac平台下沒有什麼其他的替代方法嗎，肯定是有的。特地留意了一下，發現以前真是沒有好好的使用xcode強大功能。

HeaderDoc工具

HeaderDoc是一個開源的工具，並且有集成在Xcode中，還有很強大的地方是你可以不用關心注釋的格式，或者你可以定制注釋的格式和解析的方法。

添加注釋的方法是先選中需要添加的注釋部分的代碼，默認的函數寫法需要在+/-號後面和函數名留一個空格。選中需要插入的對應類型的注釋，添加說明，不用自己一個一個的寫了。

Class header protocol都可以。

如果你知道怎麼寫腳本，甚至可以定制需要的的類型的注釋，比如默認的沒有property的注釋，你可以自己寫一個。也可以自定義快捷鍵，方便操作。

寫好的了注釋這就是需要生成可用的幫助文檔了

生成文檔的方法

用終端進入到頭文件所在地文件夾，

》headerdoc2html –o outputDir ExampleHeaders

》gatherheaderdoc outpitDir TOC.Html

outputDir是保存html的文件夾名，ExampleHeaders是保存頭文件的地方，TOC.Html是生成的文件名, 都是可以修改的。

運行完就可以在目錄下找到TOC.Html，文件這樣就可以有一份和Cocoa API Docments一樣的文檔。雖然還是Html。

其實還有很多高級的設置，可以支持用戶定制格式等，還有支持Man page Generation LanguageMPGL） Dialect，這裡就不在展開了。具體可以參看蘋果的官方的文檔HeaderDoc user Guide.