1：安裝appledoc
? ? ?使用終端下載：
? ? ? 命令行：
? ? ? ? git clone git://github.com/tomaz/appledoc.git
? ? ? ? ?cd ./appledoc
? ? ? ? sudo sh install-appledoc.sh
? 查看是否安裝成功：
? ? ? ?命令行：
? ? ? ? ?appledoc --version
如果顯示如下則安裝成功：
2：使用appledoc
使用終端到項目的目錄：
? cd ?項目路徑
使用命令行創(chuàng)建docset-installed.txt,默認(rèn)安裝到當(dāng)前項目中
appledoc --project-name 你的項目名稱 --project-company 你的公司名稱 ./
成功之后會顯示如下：
接下來在項目里創(chuàng)建新建Target：
下面?zhèn)z種都可以：
然后替換腳本：
#appledoc Xcode script
# Start constants
company="asd";//記得更改公司名
companyID="com.adaada";//記得更改公司id
companyURL="http://abc.com";//記得更改公司網(wǎng)址
target="iphoneos";
#target="macosx";
outputPath="~/help";//輸出地址
# End constants
/usr/local/bin/appledoc \
--project-name "${PROJECT_NAME}" \
--project-company "${company}" \
--company-id "${companyID}" \
--docset-atom-filename "${company}.atom" \
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
--docset-fallback-url "${companyURL}/${company}" \
--output "${outputPath}" \
--publish-docset \
--docset-platform-family "${target}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
"${PROJECT_DIR}"
最后更改好之后我們run 一下Target就可以了艺智；至于開發(fā)文檔在哪看下面的圖渗稍，
根據(jù)這個路徑我們可以找到：
然后查看包內(nèi)容可以看到：
打開index.html之后就可以看到開發(fā)文檔了
最后我要說的使用開發(fā)文檔的一些注釋方法（摘自Raybon_lee的iOS使用appledoc 生成技術(shù)API文檔詳解）：
/*!? this a test . */
?/**? this a comment. */
/// this is a long comment. */
@brief : 使用它來寫一段你正在文檔化的method, PRoperty, class, file, struct, 或enum的短描述信息。
@discusstion: 用它來寫一段詳盡的描述。如果需要你可以添加換行嘴拢。
@param:通過它你可以描述一個 method 或 function的參數(shù)信息。你可以使用多個這種標(biāo)簽。
@return: 用它來制定一個 method 或 function的返回值。
@see: 用它來指明其他相關(guān)的 method 或 function味抖。你可以使用多個這種標(biāo)簽。
@sa:同上
@code ： 使用這個標(biāo)簽灰粮，你可以在文檔當(dāng)中嵌入代碼段仔涩。當(dāng)在Help Inspector當(dāng)中查看文檔時，代碼通過在一個特別的盒子中用一種不同的字體來展示粘舟。始終記住在寫的代碼結(jié)尾處使用@endcode標(biāo)簽熔脂。
@remark : 在寫文檔時，用它來強(qiáng)調(diào)任何關(guān)于代碼的特殊之處柑肴。
@file: 使用這個標(biāo)簽來指出你正在記錄一個文件（header 文件或不是）霞揉。如果你將使用Doxygen來輸出文檔，那么你最好在這個標(biāo)簽后面緊接著寫上文件名字晰骑。它是一個top level 標(biāo)簽适秩。
@header: 跟上面的類似，但是是在 HeaderDoc中使用些侍。當(dāng)你不使用 Doxygen時隶症，不要使用上面的標(biāo)簽。
@author：用它來寫下這個文件的創(chuàng)建者信息
@copyright: 添加版權(quán)信息
@version: 用它來寫下這個文件的當(dāng)前版本岗宣。如果在工程生命周期中版本信息有影響時這會很重要。
再一次的淋样，我只給出最常用的標(biāo)簽耗式。自己查看說明文檔了解更多標(biāo)簽信息。
@class: 用它來指定一個class的注釋文檔塊的開頭趁猴。它是一個top level標(biāo)簽刊咳，在它后面應(yīng)該給出class名字。
@interface: 同上
@protocol: 同上兩個一樣儡司，只是針對protocols
@superclass: 當(dāng)前class的superclass
@classdesign: 用這個標(biāo)簽來指出你為當(dāng)前class使用的任何特殊設(shè)計模式（例如娱挨，你可以提到這個class是不是單例模式或者類似其它的模式）。
@coclass: 與當(dāng)前class合作的另外一個class的名字捕犬。
@helps: 當(dāng)前class幫助的class的名字跷坝。
@helper: 幫助當(dāng)前class的class名字酵镜。
使用HeaderDoc生成文檔
