Xcode生成API開發文檔(headerdoc, doxygen 和 appledoc)

主要參考:

iOS開發日記23-Xcode生成API文檔(HeaderDoc)

蘋果對HeaderDoc的說明文檔

代辦列表上記着的一件事,要去弄懂下Xcode上如何生成開發文檔。開發文檔的作用在於傳播和傳承,幫助其他工程師理解如何調用你的函數,也方便下個程序員接手你的工作,是合格的工程師都要去做的例行事項。當然寫完代碼,還要再寫一個開放文檔很是煩人;所以提倡代碼文檔化,代碼寫好了,文檔有就有了。

原理

在寫代碼的時候,加上適當的註釋;在利用一些工具的幫助,就可以生成完整的API文檔;如果有代碼改動,工程師也需要同時更新註釋。代碼文檔化的好處就是,代碼和文檔可以保持同步更新,而不是放在兩個地方需要分別更新。

這個是一個簡單實例,註釋必須按照格式進行編寫。具體參考文章開頭提到的蘋果說明。

/**

生成一組排列好的按鈕

@param titles 按鈕的標題列表

*/

- (void)buildBtns:(NSArray*)titles;

生成文檔的工具有三種:headerdoc, doxygen 和 appledoc。用法見文章開頭的第一個參考資料。

我親測了蘋果官方工具headerdoc。

生成工具非常強大,生成的是HTML格式,甚至可以自定義生成的樣式,也可以生成交叉索引。

有幾個注意點

1,註釋的格式不同,要挑選對於的生成工具。

2,官方的headerdoc已經不再建議使用(2016-05-05 Moved to Retired Documents Library.),原因是自從Xcode8以後使用 "Quick Help"就能看到註釋信息非常方便,如下圖。我認爲生成出文檔還是有作用的,可以傳播給其他人看,而不是非得要下載你代碼後才能看API文檔信息。


3,以上3種工具都不適用於swift,因爲它的註釋格式不一樣了。要用另外一種工具 https://github.com/realm/jazzy (我沒有親測)。

4,Xcode 8後,只要選中你要註釋的類,函數,結構體名字,然後按下 option+command+/ 就能自動生成格式化註釋白板。

歡迎大家找我交流

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章