親自體驗安裝使用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)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容