亲自体验安装使用AppleDoc(iOS编写接口文档工具(网页版))

亲自体验安装使用AppleDoc(iOS编写接口文档工具(网页版))

在写文章前,我想吐槽下,现在文章一大抄,就是看你会抄不会抄。一搜索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

当出现INSTALL SUCCESS时说明成功了,你也可以用appledoc --version查看验证下

appledoc --version

2.前期的安装搞好了,接下来是重头戏,也是最容易出错的,就是在这一步,网上一大堆错误,或者不全的教程命令,👵的

都是首先进入到工程目录下,仔细看下面截图,你就懂:

cd /Users/zhaotong/Desktop/iOS资料/思维/04-UITextField练习

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

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步后就可以在工程目录下出现doc文件夹。

Safari打开index.html就是我们最后的网页api接口文档

index.html

怎么样是不是和我们的官方文档一样😁

闲上面的2步太多,也可以试试这个方法:

appledoc --project-name="04-UITextField练习"  --project-company="ttdiOS" --company-id="com.ttdiOS" --output="./" --docset-install-path="./" .

/////////参数说明////////

生成的信息如下:

如果设置设置companyID,则生成文件名为 companyID.projectName.docset

如果不设置则文件名为com.companyname.projectname.projectName.docset

--project-name,--project-company必须输入

--output 为生成的txt文件的目录,这里设置为当前目录

--docset-install-path 为生成docket的目录,这里设置为当前目录。如果此目录不设置,默认会在~/Library/Developer/Shared/Documentation/DocSets/目录生成

/////////参数说明////////

appledoc --project-name="04-UITextField练习"  --project-company="ttdiOS" --company-id="com.ttdiOS" --output="./" --docset-install-path="./" .

会在工程目录下出现:

com.ttdiOS.04-UITextField练习.docset和docset-installed.txt

对com.ttdiOS.04-UITextField练习.docset双击出现菜单,选:显示包内容,就会出现下面的文件,最终我们需要的是:index.html(和上面的效果相同)

index.html

补充:当你cd 把工程拖入终端后,执行上面的命令后,出现:

*** 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

这样的错误时,你不要懵逼,去网上查找时,教程又是太少了,不是英文就是,抄袭别人的,驴👄不对马嘴

我当时遇到时也是很懵逼,执行别的工程都没事,唯独到用的时候了出现问题。

🙏这位的文章:Objective-C 自动生成文档工具:appledoc 使用,第一次阅读时,没读懂,多读几次就好了,其实是他把关键词写错了(本来很简单的操作,让你苦恼怎么去解决,不用怕,这时候,你今天目录中文件目录中 按照上面的操作方法再操作一次,这时候,)

正确的修改应该是:本来很简单的操作,让你苦恼怎么去解决,不用怕,这时候,你就去工程里的文件夹目录下 按照上面的操作方法再操作一次,这时候,就好了

没听懂的如图:cd到箭头的文件夹下执行命令就好了,

再不行就再进入里面的文件夹下,依次类堆。。。

个人感觉出现appledoc/Model/GBMethodData.m:44问题应该是工程太大了,进入到里面子目录下执行命令就是

也可以看看其他文章:iOS使用appledoc来创建开发文档(装逼使用)

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,612评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,814评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,427评论 0 239
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,743评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,104评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,455评论 1 214
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,764评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,454评论 0 196
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,159评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,446评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,953评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,294评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,927评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,028评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,784评论 0 193
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,485评论 2 270
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,395评论 2 264

推荐阅读更多精彩内容