用Xcode自帶headerdoc生成API文檔

Xcode生成API文檔
生成文檔有三種方式,官方支持的headerdoc,第三方的appledoc,doxygen
headerdoc的好處
官方的支持option+左鍵,xcode更新不需要額外操作
headerdoc標簽
二級標簽
@brief: 使用它來寫一段你正在文檔化的method, property, class, file, struct, 或enum的短描述信息。

@discussion: 用它來寫一段詳盡的描述。如果需要你可以添加換行。

@param: 通過它你可以描述一個 method 或 function的參數(shù)信息。你可以使用多個這種標簽。

@return: 用它來制定一個 method 或 function的返回值。

@see: 用它來指明其他相關(guān)的 method 或 function。你可以使用多個這種標簽。

@sa: 同前一條類似。

@code: 使用這個標簽,你可以在文檔當(dāng)中嵌入代碼段。當(dāng)在Help Inspector當(dāng)中查看文檔時,代碼通過在一個特別的盒子中用一種不同的字體來展示。始終記住在寫的代碼結(jié)尾處使用@endcode標簽。

@remark:在寫文檔時,用它來強調(diào)任何關(guān)于代碼的特殊之處。

一級標簽
@file: 使用這個標簽來指出你正在記錄一個文件(header 文件或不是)。如果你將使用Doxygen來輸出文檔,那么你最好在這個標簽后面緊接著寫上文件名字。它是一個top level 標簽。

@header: 跟上面的類似,但是是在 HeaderDoc中使用。當(dāng)你不使用 Doxygen時,不要使用上面的標簽。

@author:用它來寫下這個文件的創(chuàng)建者信息

@copyright: 添加版權(quán)信息

@version: 用它來寫下這個文件的當(dāng)前版本。如果在工程生命周期中版本信息有影響時這會很重要。

@class: 用它來指定一個class的注釋文檔塊的開頭。它是一個top level標簽,在它后面應(yīng)該給出class名字。

@interface: 同上

@protocol: 同上兩個一樣,只是針對protocols

@superclass: 當(dāng)前class的superclass

@classdesign: 用這個標簽來指出你為當(dāng)前class使用的任何特殊設(shè)計模式(例如,你可以提到這個class是不是單例模式或者類似其它的模式)。

@coclass: 與當(dāng)前class合作的另外一個class的名字。

@helps: 當(dāng)前class幫助的class的名字。

@helper: 幫助當(dāng)前class的class名字。

headerdoc生成API命令
terminal定位到包含工程的根目錄
headerdoc2html -o /Users/admin/Desktop/changeMethod/doc /Users/admin/Desktop/changeMethod

http://www.cnblogs.com/Twisted-Fate/p/4829417.html
https://shengpan.net/headerdoc/

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,554評論 19 139
  • 前言 在一個應(yīng)用的整個開發(fā)過程中涉及到了無數(shù)的步驟。其中一些是應(yīng)用的說明 , 圖片的創(chuàng)作 , 應(yīng)用的實現(xiàn) , 和實...
    與偉大LEE同行閱讀 4,126評論 3 6
  • 轉(zhuǎn)至元數(shù)據(jù)結(jié)尾創(chuàng)建: 董瀟偉,最新修改于: 十二月 23, 2016 轉(zhuǎn)至元數(shù)據(jù)起始第一章:isa和Class一....
    40c0490e5268閱讀 2,053評論 0 9
  • 我就駐立在青草之上 用一年的清晨與夜星 等著 你沿石徑緩緩走來 你拿著一束純白的桔梗 往我身上一放 星辰,太陽和埋...
    娃娃的manly閱讀 406評論 1 3
  • 第一段 1.預(yù)備勢2.太極起勢3.攬雀尾4.單鞭5.提手上勢6.白鶴亮翅7.摟膝拗步8.手揮琵琶9.進步搬攔捶10...
    起合太極孫康閱讀 2,004評論 0 0

友情鏈接更多精彩內(nèi)容