親自體驗(yàn)安裝使用AppleDoc(iOS編寫接口文檔工具(網(wǎng)頁(yè)版))
在寫文章前,我想吐槽下,現(xiàn)在文章一大抄,就是看你會(huì)抄不會(huì)抄。一搜索AppleDoc教程一大堆,但是按照教程做的話,又是錯(cuò)誤一大堆,每個(gè)教程似乎出自一個(gè)人的風(fēng)格,太奇怪了,有規(guī)則和業(yè)界良心(可以借鑒別人的,但是也要改改啊,不提倡自己不親自操作下就抄襲別人的文章)???要么不寫,要寫就寫自己的體驗(yàn)感受。對(duì)于我這樣的小白,看著文檔,截圖教程又不全面,實(shí)在是抓耳撓腮。。。
于是決定自己寫一下教程:
1:安裝appledoc
使用終端下載:
命令行:
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh
查看是否安裝成功:
命令行:
appledoc --version
當(dāng)出現(xiàn)INSTALL SUCCESS時(shí)說明成功了,你也可以用appledoc --version查看驗(yàn)證下
2.前期的安裝搞好了,接下來是重頭戲,也是最容易出錯(cuò)的,就是在這一步,網(wǎng)上一大堆錯(cuò)誤,或者不全的教程命令,??的
都是首先進(jìn)入到工程目錄下,仔細(xì)看下面截圖,你就懂:
cd /Users/zhaotong/Desktop/iOS資料/思維/04-UITextField練習(xí)
appledoc --output ./doc --project-name 04-UITextField練習(xí) --project-company "ttdiOS" --company-id "com.ttdiOS" .
appledoc --no-create-docset --output ./doc --project-name 04-UITextField練習(xí) --project-company "ttdiOS" --company-id "com.ttdiOS" .
上面的2步后就可以在工程目錄下出現(xiàn)doc文件夾。
Safari打開index.html就是我們最后的網(wǎng)頁(yè)api接口文檔
怎么樣是不是和我們的官方文檔一樣??
閑上面的2步太多,也可以試試這個(gè)方法:
appledoc --project-name="04-UITextField練習(xí)"? --project-company="ttdiOS" --company-id="com.ttdiOS" --output="./" --docset-install-path="./" .
/////////參數(shù)說明////////
生成的信息如下:
如果設(shè)置設(shè)置companyID,則生成文件名為 companyID.projectName.docset
如果不設(shè)置則文件名為com.companyname.projectname.projectName.docset
--project-name,--project-company必須輸入
--output 為生成的txt文件的目錄,這里設(shè)置為當(dāng)前目錄
--docset-install-path 為生成docket的目錄,這里設(shè)置為當(dāng)前目錄。如果此目錄不設(shè)置,默認(rèn)會(huì)在~/Library/Developer/Shared/Documentation/DocSets/目錄生成
/////////參數(shù)說明////////
會(huì)在工程目錄下出現(xiàn):
對(duì)com.ttdiOS.04-UITextField練習(xí).docset雙擊出現(xiàn)菜單,選:顯示包內(nèi)容,就會(huì)出現(xiàn)下面的文件,最終我們需要的是:index.html(和上面的效果相同)
補(bǔ)充:當(dāng)你cd 把工程拖入終端后,執(zhí)行上面的命令后,出現(xiàn):
*** Assertion failure in +[GBMethodData methodDataWithType:result:arguments:], /Users/zhaotong/Desktop/911doc/appledoc/Model/GBMethodData.m:44
Oops, something went wrong...
NSInternalInconsistencyException: Invalid parameter not satisfying: [arguments count] >= 1
這樣的錯(cuò)誤時(shí),你不要懵逼,去網(wǎng)上查找時(shí),教程又是太少了,不是英文就是,抄襲別人的,驢??不對(duì)馬嘴
我當(dāng)時(shí)遇到時(shí)也是很懵逼,執(zhí)行別的工程都沒事,唯獨(dú)到用的時(shí)候了出現(xiàn)問題。
??這位的文章:Objective-C 自動(dòng)生成文檔工具:appledoc 使用,第一次閱讀時(shí),沒讀懂,多讀幾次就好了,其實(shí)是他把關(guān)鍵詞寫錯(cuò)了(本來很簡(jiǎn)單的操作,讓你苦惱怎么去解決,不用怕,這時(shí)候,你今天目錄中文件目錄中 按照上面的操作方法再操作一次,這時(shí)候,)
正確的修改應(yīng)該是:本來很簡(jiǎn)單的操作,讓你苦惱怎么去解決,不用怕,這時(shí)候,你就去工程里的文件夾目錄下 按照上面的操作方法再操作一次,這時(shí)候,就好了
沒聽懂的如圖:cd到箭頭的文件夾下執(zhí)行命令就好了,
再不行就再進(jìn)入里面的文件夾下,依次類堆。。。
也可以看看其他文章:iOS使用appledoc來創(chuàng)建開發(fā)文檔(裝逼使用)