親自體驗(yàn)安裝使用AppleDoc(iOS編寫接口文檔工具(網(wǎng)頁(yè)版))

親自體驗(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

git clone git://github.com/tomaz/appledoc.git
git clone git://github.com/tomaz/appledoc.git
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh

當(dāng)出現(xiàn)INSTALL SUCCESS時(shí)說明成功了,你也可以用appledoc --version查看驗(yàn)證下

appledoc --version

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" .

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接口文檔

index.html

怎么樣是不是和我們的官方文檔一樣??

閑上面的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ù)說明////////

appledoc --project-name="04-UITextField練習(xí)"? --project-company="ttdiOS" --company-id="com.ttdiOS" --output="./" --docset-install-path="./" .

會(huì)在工程目錄下出現(xiàn):

com.ttdiOS.04-UITextField練習(xí).docset和docset-installed.txt

對(duì)com.ttdiOS.04-UITextField練習(xí).docset雙擊出現(xiàn)菜單,選:顯示包內(nèi)容,就會(huì)出現(xiàn)下面的文件,最終我們需要的是:index.html(和上面的效果相同)

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

appledoc/Model/GBMethodData.m:44

這樣的錯(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)入里面的文件夾下,依次類堆。。。

個(gè)人感覺出現(xiàn)appledoc/Model/GBMethodData.m:44問題應(yīng)該是工程太大了,進(jìn)入到里面子目錄下執(zhí)行命令就是

也可以看看其他文章:iOS使用appledoc來創(chuàng)建開發(fā)文檔(裝逼使用)

我的工程demo:https://github.com/mrzhao12/AppleDoc

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,606評(píng)論 6 533
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,582評(píng)論 3 418
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,540評(píng)論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,028評(píng)論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,801評(píng)論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,223評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,294評(píng)論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,442評(píng)論 0 289
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,976評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,800評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,996評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,543評(píng)論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,233評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評(píng)論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,926評(píng)論 1 286
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,702評(píng)論 3 392
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,991評(píng)論 2 374

推薦閱讀更多精彩內(nèi)容