iOS-Xcode --- 生成技术文档之appledoc(装逼利器)

最近有点小忙,好久没有写文章了。今天我们聊一聊Objective-C技术文档。
独立开发可以不管这些,不过做项目的人多了,就需要文档了,方便其他人员查看使用。手工写文档是一件苦差事,经过查找发现了从源码中抽取注释生成文档的专用工具:

[doxygen](http://www.stack.nl/~dimitri/doxygen/index.html):适于生成html文档与pdf文档。 支持的语言多,可以配置的地方也比较多。默认生成的风格与苹果的风格不一致。
[headdoc](http://developer.apple.com/opensource/tools/headerdoc.html) :是 Xcode 自带的文档生成工具。在安装完 Xcode 后,就可以用命令行来生成对应的文档。不过它只生成以/*! */
的格式的注释。不兼容 /** */
格式的注释
[appledoc](http://gentlebytes.com/appledoc/): [Github地址](https://github.com/tomaz/appledoc) ,适于生成html文档和xcode帮助文档(docset)。可以兼容 /** */
格式,也可以兼容 /*! */
格式的注释。

这些都是前人总结的特点我也没有一个个尝试,我直接选取了 appledoc,下面是安装步骤和使用步骤。

安装

两种方式:
1 如果你装了homebrew,打开终端,输入以下命令:

brew install appledoc

第一次用的这种方式,安装虽然成功了但是去找不到生成的html文件,后来找到了文件打开之后里面的内容却不对,所以如果有朋友看到后可以告诉我怎么回事,先谢谢了~
2 打开终端,输入以下命令:

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

安装成功会出现


appledoc.png
使用

首先创建一个项目appledoc,为了便于演示,写几个注释:


code.png

打开终端进入项目目录

cd.png

使用命令创建

//格式:appledoc --project-name 你的项目名称 --project-company 你的公司名称 ./
        appledoc --project-name appledoc --project-company kt ./

之后打开你的工程文件会看到:


project.png

这里的路径就是生成文档的路径了,一般是html格式,顺着路径找下去如图:


docset.png

右键显示包内容
index.png

这个html文件就是你需要的了打开如下:


doc.png

all.png

network.png

此时在Xcode中也帮你生成了文档:
退出Xcode,重新打开工程选择在 Help—Documentation and API Reference中也可以看到


doc.png

当然如果你只是想生成一分html文档的话就只要用终端进入工程目录之后执行下列命令:

//加入--no-create-docset

appledoc --no-create-docset --project-name appledoc --project-company kt ./

虽然有提示但是不影响使用(额,其实是不知道怎么解决,哈哈😀)
在工程目录中会发现多了一个


66F0B049-40D5-4256-B5C7-DFDF354E246B.png
html.png

点击打开发现和刚才的那个一样哎😔
这个就是你的技术文档了,方便他人查看使用。
希望对各位有所帮助吧,别忘了喜欢单赞收藏转发~~~

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

推荐阅读更多精彩内容