iOS-Mac安裝使用AppleDoc(導出技術接口文檔工具(網頁版))

一搜索AppleDoc教程一大堆驯击,但是按照教程做的話,又是錯誤一大堆,每個教程似乎出自一個人的風格则披,太奇怪了,于是決定自己寫一下教程:

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


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

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

推薦使用第二種

appledoc --output ./doc --project-name 04-UITextField練習 --project-company "ttdiOS" --company-id "com.ttdiOS" .


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ù)說明////////

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


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

com.ttdiOS.04-UITextField練習.docset和docset-installed.txt


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

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

appledoc/Model/GBMethodData.m:44


這樣的錯誤時沿癞,你不要懵逼,去網上查找時扰肌,教程又是太少了抛寝,不是英文就是,抄襲別人的曙旭,驢??不對馬嘴

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

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

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

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

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

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

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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末望浩,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子惰说,更是在濱河造成了極大的恐慌,老刑警劉巖缘回,帶你破解...
    沈念sama閱讀 217,185評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件吆视,死亡現(xiàn)場離奇詭異禁荸,居然都是意外死亡棚愤,警方通過查閱死者的電腦和手機皿伺,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,652評論 3 393
  • 文/潘曉璐 我一進店門坞嘀,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蟋座,“玉大人最易,你說我怎么就攤上這事假勿≌馕牵” “怎么了肆糕?”我有些...
    開封第一講書人閱讀 163,524評論 0 353
  • 文/不壞的土叔 我叫張陵般堆,是天一觀的道長。 經常有香客問我诚啃,道長淮摔,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,339評論 1 293
  • 正文 為了忘掉前任始赎,我火速辦了婚禮和橙,結果婚禮上仔燕,老公的妹妹穿的比我還像新娘。我一直安慰自己魔招,他們只是感情好晰搀,可當我...
    茶點故事閱讀 67,387評論 6 391
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著办斑,像睡著了一般厕隧。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上俄周,一...
    開封第一講書人閱讀 51,287評論 1 301
  • 那天吁讨,我揣著相機與錄音,去河邊找鬼峦朗。 笑死建丧,一個胖子當著我的面吹牛,可吹牛的內容都是我干的波势。 我是一名探鬼主播翎朱,決...
    沈念sama閱讀 40,130評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼尺铣!你這毒婦竟也來了拴曲?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 38,985評論 0 275
  • 序言:老撾萬榮一對情侶失蹤凛忿,失蹤者是張志新(化名)和其女友劉穎澈灼,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體店溢,經...
    沈念sama閱讀 45,420評論 1 313
  • 正文 獨居荒郊野嶺守林人離奇死亡叁熔,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,617評論 3 334
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了床牧。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片荣回。...
    茶點故事閱讀 39,779評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖戈咳,靈堂內的尸體忽然破棺而出心软,到底是詐尸還是另有隱情,我是刑警寧澤著蛙,帶...
    沈念sama閱讀 35,477評論 5 345
  • 正文 年R本政府宣布删铃,位于F島的核電站,受9級特大地震影響册踩,放射性物質發(fā)生泄漏泳姐。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,088評論 3 328
  • 文/蒙蒙 一暂吉、第九天 我趴在偏房一處隱蔽的房頂上張望胖秒。 院中可真熱鬧缎患,春花似錦、人聲如沸阎肝。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,716評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽风题。三九已至判导,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間沛硅,已是汗流浹背眼刃。 一陣腳步聲響...
    開封第一講書人閱讀 32,857評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留摇肌,地道東北人擂红。 一個月前我還...
    沈念sama閱讀 47,876評論 2 370
  • 正文 我出身青樓,卻偏偏與公主長得像围小,于是被迫代替她去往敵國和親昵骤。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,700評論 2 354