在Xcode8下文档化你的Objective-C代码

苹果在Xcode8为了安全性和稳定性,禁用第三方插件。
第三方注释插件VVDocumenter虽然不能在Xcode8上继续使用,但所幸苹果在此插件基础上提供了快熟注释的功能。

Xcode8 注释

在Xcode8上可以通过快捷键 (⌥ Option + ⌘ Command + /) 添加注释。
格式为 /** … */

属性注释
属性注释

添加的注释可以在不同地方展示
1.Utilities面板的Quick Help Inspector

Quick Help Inspector
Quick Help Inspector

2.当你按下Option键然后点击备注的方法、类或属性名时弹出的帮助菜单 Help Popup 里

Help Popup
Help Popup

3.在代码实现的弹框里
但不同的注释显示有所不同,如:
属性注释写在.h文件:

.h属性注释
.h属性注释

如果写在.m文件,弹框是不显示注释的:

.m属性注释
.m属性注释

方法注释无论写在哪儿都是可以显示:

.h方法注释
.h方法注释
.m方法注释

下面看下带不同标签的注释

@return
返回参数

返回参数

@param
参数

参数

多个参数


@code ... @endcode
代码标签

@remark
粗体提醒

标签

我们做注释是为了能够输出有效的文档,方便查询。
市面上有不同插件可以输出文档,但各自的识别格式、标签和输出的风格大不相同。
这次我们用Jazzy插件来进行文档化注释,Jazzy不识别@code和@remark ,这里仅仅只是展示一下标签效果,如果对标签感兴趣,可以查阅文档。
苹果HeaderDoc文档可以参考更多标签,但该文档已经过期,Xcode8中有些已经无效。

四种文档输出工具

HeaderDoc Xcode自带,有详细文档。却只识别/! … /格式,不符合Xcode8快捷注释输出的格式,不是很方便。而且输出的文档零散,没有集合跳转的主页。
Docxygen 支持多语言注释,识别的标签和输出的风格和苹果风格不同,也不是很符合Xcode8快捷注释。
AppleDoc 可以输出与苹果风格相似的文档,也能识别/
… */格式、且能输出文档docset文件。但是Xcode8下好像不管用了,内容不能有效输出。所以也不用这个。
Jazzy 可以输出Swift 和Objective-C文档,且风格几乎和苹果一致,且支持自定义输出主题,能识别快速注释的格式,既有集合跳转的主页也能输出docset文档。所以选这个

Jazzy

官方Git Jazzy

1.安装

sudo gem install jazzy

在命令行执行命令

查看帮助

jazzy-h

输出文档

jazzy \
  --objc \
  --author 小明 \
  --module-version 1.0.0 \
  --umbrella-header DocumentObjC/ViewController.h \
  --framework-root . \
  --module 模块名称   \
  --output docs/objc_output

上面有部分是必须的参数:

--objc
--umbrella-header 汇总的头文件路径,会把该文件引入的其他文件一同输出,所以是必须的(一般框架习惯会有一个汇总的头文件,引入模块涉及到的文件)
--framework-root 框架root路径
--output docs/objc_output 输出的路径

框架路径和头文件路径、输出的路径都是你执行命令的相对路径。

输出效果如下:


文件路径

文档文件:


文档路径

打开index.html:


文档主页

更多命令细节可以查看Git文档
文档所列命令参数有限,也可以查看Git源文件jazzy/lib/jazzy/config.rb查看所有参数

参考
Documenting Your Objective-C and Swift Code in Xcode with HeaderDoc and Doxygen

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

推荐阅读更多精彩内容