前言：
網(wǎng)上很多關(guān)于appledoc的使用堰汉，要么比較久的辽社，要么講解的不是很清晰，按照他們的步驟執(zhí)行沒(méi)成功翘鸭，so爹袁，根據(jù)自己安裝使用成功和遇到的問(wèn)題，記錄一下：
背景：
項(xiàng)目源碼交接給另外一個(gè)公司的開(kāi)發(fā)人員矮固，需要為他們提供app大致的使用文檔失息，CTO問(wèn)：你們是否有類似java的javadoc源碼文檔工具譬淳，百度了一下：答案是有的，iOS也有appledoc盹兢，而且appledoc最后生成一個(gè)indxe.html文件邻梆，打開(kāi)index.html文件會(huì)顯示iOS官方API一樣風(fēng)格的文檔，是不是還蠻棒棒的绎秒！
體驗(yàn)：
安裝：打開(kāi)終端一步步執(zhí)行下面的命令
$ git clone git://github.com/tomaz/appledoc.git
$ cd ./appledoc
$ sudo sh install-appledoc.sh
驗(yàn)證：安裝是否成功
# 查看版本浦妄，如果顯示版本，則證明安裝成功
$ appledoc --version
# 查看appledoc的命令
$ appledoc --help
appledoc --version
使用：重點(diǎn)來(lái)拉见芹，認(rèn)真執(zhí)行下面這三個(gè)步驟就行剂娄，看清截圖
- 1、創(chuàng)建一個(gè)Xcode項(xiàng)目玄呛，項(xiàng)目名：demo阅懦，并創(chuàng)建一個(gè)文件測(cè)試生成文檔；
- 2徘铝、cd 到項(xiàng)目文件夾耳胎；
- 3、執(zhí)行終端命令
具體步驟： -
1惕它、創(chuàng)建一個(gè)Xcode項(xiàng)目怕午，項(xiàng)目名：demo，并創(chuàng)建一個(gè)文件測(cè)試生成文檔：
SoundBusTool類 - 2淹魄、cd 到項(xiàng)目文件夾：
cd 到項(xiàng)目的文件夾
項(xiàng)目目錄
- 3郁惜、執(zhí)行終端命令
$ appledoc --no-create-docset --output="./doc" --project-name="工程名" --company-id="bundle id" --project-company="公司名" .
執(zhí)行終端命令
打開(kāi)index.html文件
查看文檔
遇到的兩個(gè)問(wèn)題：
-
問(wèn)題1:執(zhí)行終端命令doc文件夾下沒(méi)有生成index.html文件，原因是：沒(méi)有給Xcode創(chuàng)建的demo項(xiàng)目寫(xiě)注釋甲锡，解決扳炬，如果我在appdelegate.h中，隨便給方法添加一個(gè)注釋搔体，然后在執(zhí)行終端命令就能成功生成index.html文件；
問(wèn)題1錯(cuò)誤提示docsetutil：
解決1 -
問(wèn)題2:在原來(lái)的項(xiàng)目中半醉，執(zhí)行命令疚俱，沒(méi)有生成doc文件夾；
問(wèn)題2錯(cuò)誤提示：Invalid parameter not satisfying: [arguments count] >= 1
解決2
靠譜的參考：
參考鏈接1
參考鏈接2
本人的一點(diǎn)開(kāi)發(fā)小記缩多，如果對(duì)你有幫助歡迎小????呆奕，另不吝賜教。
