Xcode生成API文檔
生成文檔有三種方式，官方支持的headerdoc，第三方的appledoc，doxygen
headerdoc的好處
官方的支持option+左鍵，xcode更新不需要額外操作
headerdoc標(biāo)簽
二級(jí)標(biāo)簽
@brief: 使用它來(lái)寫(xiě)一段你正在文檔化的method, property, class, file, struct, 或enum的短描述信息。
@discussion: 用它來(lái)寫(xiě)一段詳盡的描述。如果需要你可以添加換行。
@param: 通過(guò)它你可以描述一個(gè) method 或 function的參數(shù)信息。你可以使用多個(gè)這種標(biāo)簽。
@return: 用它來(lái)制定一個(gè) method 或 function的返回值。
@see: 用它來(lái)指明其他相關(guān)的 method 或 function。你可以使用多個(gè)這種標(biāo)簽。
@sa: 同前一條類(lèi)似。
@code: 使用這個(gè)標(biāo)簽，你可以在文檔當(dāng)中嵌入代碼段。當(dāng)在Help Inspector當(dāng)中查看文檔時(shí)，代碼通過(guò)在一個(gè)特別的盒子中用一種不同的字體來(lái)展示。始終記住在寫(xiě)的代碼結(jié)尾處使用@endcode標(biāo)簽。
@remark:在寫(xiě)文檔時(shí)，用它來(lái)強(qiáng)調(diào)任何關(guān)于代碼的特殊之處。
一級(jí)標(biāo)簽
@file: 使用這個(gè)標(biāo)簽來(lái)指出你正在記錄一個(gè)文件（header 文件或不是）。如果你將使用Doxygen來(lái)輸出文檔，那么你最好在這個(gè)標(biāo)簽后面緊接著寫(xiě)上文件名字。它是一個(gè)top level 標(biāo)簽。
@header: 跟上面的類(lèi)似，但是是在 HeaderDoc中使用。當(dāng)你不使用 Doxygen時(shí)，不要使用上面的標(biāo)簽。
@author：用它來(lái)寫(xiě)下這個(gè)文件的創(chuàng)建者信息
@copyright: 添加版權(quán)信息
@version: 用它來(lái)寫(xiě)下這個(gè)文件的當(dāng)前版本。如果在工程生命周期中版本信息有影響時(shí)這會(huì)很重要。
@class: 用它來(lái)指定一個(gè)class的注釋文檔塊的開(kāi)頭。它是一個(gè)top level標(biāo)簽，在它后面應(yīng)該給出class名字。
@interface: 同上
@protocol: 同上兩個(gè)一樣，只是針對(duì)protocols
@superclass: 當(dāng)前class的superclass
@classdesign: 用這個(gè)標(biāo)簽來(lái)指出你為當(dāng)前class使用的任何特殊設(shè)計(jì)模式（例如，你可以提到這個(gè)class是不是單例模式或者類(lèi)似其它的模式）。
@coclass: 與當(dāng)前class合作的另外一個(gè)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/
