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

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

在寫文章前,我想吐槽下,現(xiàn)在文章一大抄,就是看你會抄不會抄。一搜索AppleDoc教程一大堆,但是按照教程做的話,又是錯誤一大堆,每個教程似乎出自一個人的風(fēng)格,太奇怪了,有規(guī)則和業(yè)界良心(可以借鑒別人的,但是也要改改啊,不提倡自己不親自操作下就抄襲別人的文章)???要么不寫,要寫就寫自己的體驗感受。對于我這樣的小白,看著文檔,截圖教程又不全面,實在是抓耳撓腮。。。

于是決定自己寫一下教程:

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時說明成功了,你也可以用appledoc --version查看驗證下

appledoc --version

2.前期的安裝搞好了,接下來是重頭戲,也是最容易出錯的,就是在這一步,網(wǎng)上一大堆錯誤,或者不全的教程命令,??的

都是首先進入到工程目錄下,仔細看下面截圖,你就懂:

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

index.html

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

閑上面的2步太多,也可以試試這個方法:

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è)置,默認會在~/Library/Developer/Shared/Documentation/DocSets/目錄生成

/////////參數(shù)說明////////

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

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

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

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

index.html

補充:當(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

這樣的錯誤時,你不要懵逼,去網(wǎng)上查找時,教程又是太少了,不是英文就是,抄襲別人的,驢??不對馬嘴

我當(dāng)時遇到時也是很懵逼,執(zhí)行別的工程都沒事,唯獨到用的時候了出現(xiàn)問題。

??這位的文章:Objective-C 自動生成文檔工具:appledoc 使用,第一次閱讀時,沒讀懂,多讀幾次就好了,其實是他把關(guān)鍵詞寫錯了(本來很簡單的操作,讓你苦惱怎么去解決,不用怕,這時候,你今天目錄中文件目錄中 按照上面的操作方法再操作一次,這時候,)

正確的修改應(yīng)該是:本來很簡單的操作,讓你苦惱怎么去解決,不用怕,這時候,你就去工程里的文件夾目錄下 按照上面的操作方法再操作一次,這時候,就好了

沒聽懂的如圖:cd到箭頭的文件夾下執(zhí)行命令就好了,

再不行就再進入里面的文件夾下,依次類堆。。。

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

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

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

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

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