一搜索AppleDoc教程一大堆驯击,但是按照教程做的話,又是錯誤一大堆,每個教程似乎出自一個人的風格则披,太奇怪了,于是決定自己寫一下教程:
1:安裝appledoc
使用終端下載:
命令行:
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh
查看是否安裝成功:
命令行:
appledoc --version
當出現(xiàn)INSTALL SUCCESS時說明成功了洗出,你也可以用appledoc --version查看驗證下
2.前期的安裝搞好了士复,接下來是重頭戲,也是最容易出錯的翩活,就是在這一步阱洪,網上一大堆錯誤,或者不全的教程命令菠镇,??的
都是首先進入到工程目錄下冗荸,仔細看下面截圖,你就懂:
cd /Users/zhaotong/Desktop/iOS資料/思維/04-UITextField練習
1: ? appledoc --output ./doc --project-name 04-UITextField練習 --project-company "ttdiOS" --company-id "com.ttdiOS" .
2: ? appledoc --no-create-docset --output ./doc --project-name 04-UITextField練習 --project-company "ttdiOS" --company-id "com.ttdiOS" .
推薦使用第二種
上面的2步后就可以在工程目錄下出現(xiàn)doc文件夾利耍。
Safari打開index.html就是我們最后的網頁api接口文檔
index.html
怎么樣是不是和我們的官方文檔一樣??
閑上面的2步太多蚌本,也可以試試這個方法:
appledoc --project-name="04-UITextField練習"? --project-company="ttdiOS" --company-id="com.ttdiOS" --output="./" --docset-install-path="./" .
/////////參數(shù)說明////////
生成的信息如下:
如果設置設置companyID,則生成文件名為 companyID.projectName.docset
如果不設置則文件名為com.companyname.projectname.projectName.docset
--project-name隘梨,--project-company必須輸入
--output 為生成的txt文件的目錄程癌,這里設置為當前目錄
--docset-install-path 為生成docket的目錄,這里設置為當前目錄轴猎。如果此目錄不設置嵌莉,默認會在~/Library/Developer/Shared/Documentation/DocSets/目錄生成
/////////參數(shù)說明////////
會在工程目錄下出現(xiàn):
對com.ttdiOS.04-UITextField練習.docset雙擊出現(xiàn)菜單,選:顯示包內容捻脖,就會出現(xiàn)下面的文件锐峭,最終我們需要的是:index.html(和上面的效果相同)
補充:當你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
這樣的錯誤時沿癞,你不要懵逼,去網上查找時扰肌,教程又是太少了抛寝,不是英文就是,抄襲別人的曙旭,驢??不對馬嘴
我當時遇到時也是很懵逼盗舰,執(zhí)行別的工程都沒事,唯獨到用的時候了出現(xiàn)問題桂躏。
??這位的文章:Objective-C 自動生成文檔工具:appledoc 使用钻趋,第一次閱讀時,沒讀懂剂习,多讀幾次就好了蛮位,其實是他把關鍵詞寫錯了(本來很簡單的操作较沪,讓你苦惱怎么去解決,不用怕失仁,這時候尸曼,你今天目錄中文件目錄中 按照上面的操作方法再操作一次,這時候萄焦,)
正確的修改應該是:本來很簡單的操作控轿,讓你苦惱怎么去解決,不用怕拂封,這時候茬射,你就去工程里的文件夾目錄下 按照上面的操作方法再操作一次,這時候冒签,就好了
沒聽懂的如圖:cd到箭頭的文件夾下執(zhí)行命令就好了在抛,
再不行就再進入里面的文件夾下,依次類堆萧恕。刚梭。。
個人感覺出現(xiàn)appledoc/Model/GBMethodData.m:44問題應該是工程太大了廊鸥,進入到里面子目錄下執(zhí)行命令就是
也可以看看其他文章:iOS使用appledoc來創(chuàng)建開發(fā)文檔(裝逼使用)