【作者前言】：13年入圈，分享些本人工作中遇到的點(diǎn)點(diǎn)滴滴那些事兒矮固，17年剛開始寫博客括细，高手勿噴骏庸！以分享交流為主，歡迎各路豪杰點(diǎn)評(píng)改進(jìn)袒啼！
1.應(yīng)用場(chǎng)景：
編寫類似于蘋果官方文檔的Html接口文檔哈扮，做過(guò)SDK開發(fā)的朋友們應(yīng)該很清楚appledoc的強(qiáng)大之處。這里不做過(guò)多解釋蚓再，經(jīng)過(guò)實(shí)際應(yīng)用做比對(duì)滑肉，headerDoc(蘋果自帶)與appledoc，選擇了后者摘仅。
2.實(shí)現(xiàn)目標(biāo)：
實(shí)戰(zhàn)層面上靶庙，真正的將appledoc使用起來(lái)，Get該項(xiàng)技能
實(shí)際使用上問(wèn)題挺多娃属，尤其Xcode9之后六荒，普遍的方法會(huì)出現(xiàn)此錯(cuò)誤：ERROR | !> xcrun: error: unable to find utility "docsetutil", not a developer tool or in PATH
借鑒了許多Stack Overflow，Github上的issue矾端，嘗試了許多掏击，最終使用了本篇文章介紹的方法。
3.代碼說(shuō)明：
1.安裝appledoc(推薦直接使用終端下載须床，依次執(zhí)行命令即可)
1)git clone git://github.com/tomaz/appledoc.git
2)cd ./appledoc
3)sudo sh install-appledoc.sh
校驗(yàn)下是否安裝成功?!
4)appledoc --version
ｎ砹稀！豺旬！概率性極低的雷區(qū)：安裝過(guò)程中如遇到 CommandLineTools錯(cuò)誤钠惩，如圖：
則直接如圖勾選后即可
2.開始實(shí)戰(zhàn)！Ｗ逶摹篓跛！
摒棄采用命令行創(chuàng)建doc文件等..以及Xcode內(nèi)添加執(zhí)行腳本的方式，而是采用最直接的方式：
終端->編寫腳本->運(yùn)行腳本->更新腳本從而規(guī)避docsetutil找不到等錯(cuò)誤坦刀，更加方便維護(hù)愧沟！
1）來(lái)到對(duì)應(yīng)的工程文件路徑下
cd testAppledocDemo
2)在工程目下創(chuàng)建一個(gè)腳本，如myProDoc.sh
vim myProDoc.sh
使用vim命令可通過(guò)命令 i 直接進(jìn)入編輯模式鲤遥，更為快捷
3)編輯myProDoc.sh腳本
#!/bin/bash
appledoc \
#文檔輸出目錄
--output ./apiDoc \
#忽略.m文件沐寺，因.m中均為私有api和屬性，開源的接口文檔中理應(yīng)忽略掉
-i *.m \
#工程的名字
--project-name "testAppledocDemo" \
#公司的名字
--project-company "Zyp" \
#不生成docset盖奈，直接輸出html
--no-create-docset \
#沒(méi)有注釋的文件也輸出html -->目的是看到所有的文件
--keep-undocumented-objects \
#沒(méi)有注釋的屬性和方法也輸出到html -->目的是看到所有的屬性和方法
--keep-undocumented-members \
#沒(méi)有注釋的文件不提示警告
--no-warn-undocumented-object \
#沒(méi)有注釋的屬性和方法不提示警告
--no-warn-undocumented-member \
#需要輸出的文件路徑 -->這里推薦最好直接為當(dāng)前工程路徑平級(jí)輸出混坞，便于維護(hù)和使用
./
4):wq 保存并退出
5)執(zhí)行腳本
./myProDoc.sh
如遇權(quán)限錯(cuò)誤 -bash: ./myProDoc.sh: Permission denied
則處理下腳本文件屬性，使腳本具有執(zhí)行權(quán)限
chmod +x myProDoc.sh
執(zhí)行完腳本后...
我們的工程文件目錄下就會(huì)生成如下結(jié)構(gòu)的文件目錄...
image.png
6)打開index.html，見證裝逼時(shí)刻...(O(∩_∩)O~)
＞吭小Ｉ督础！Attention---注釋要合規(guī)厨诸，保持良好的代碼寫作習(xí)慣镶殷，則會(huì)自動(dòng)生成對(duì)應(yīng)的文檔！Ｎ⒊辍绘趋！
3.列舉一些Beautiful的注釋，更多就自己摸索吧...
/**
@brief -->簡(jiǎn)要描述
@param -->用于參數(shù)說(shuō)明
@see -->可見的鏈接性說(shuō)明得封，文檔中可對(duì)應(yīng)鏈接到內(nèi)容 一般可用于注釋枚舉屬性的類型
@discussion -->詳細(xì)說(shuō)明 提醒信息
@warning -->警告內(nèi)容
@bug -->bug內(nèi)容
@return -->返回值說(shuō)明
*/
效果如圖:
