Xcode 8自动生成的快速帮助文档


85

Xcode 8中宣布的新功能中,我们可以看到

“自动生成快速帮助文档”:

在此处输入图片说明

就像我们可以从NSHipster上学习本文一样,手动代码文档到此结束了吗?

有人可以概述此新功能的优缺点吗?它会取代Jazzy之类的工具吗?

我找不到有关新功能的更多信息。


@Rob:知道如何在不麻烦的情况下安装Xcode 8bêta并立即将其卸载(未经授权将其安装在我的工作Mac上)的
想法

WWDC 2016的一些视频中对此进行了演示。
罗布


2
您可以在37:00的视频中看到一个演示-但是我无法使其真正起作用!我已经尝试过使用swift和obj-c以及所选功能的各个不同部分。
迷糊的Vorlon

Answers:


203

这指的是Xcode 8(及更高版本)功能,您可以在其中选择如下方法:

func foo(bar: Int) -> String { ... }

...,然后按+ option+ /(或从Xcode的“编辑器”菜单中选择“结构”»“添加文档”),它将为您生成以下注释模板:

/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>

它只是有助于快速帮助文档的编写。


请注意,尽管这种行为随着时间的流逝有所改变,但是Xcode可能会特别说明您在尝试执行此操作时光标必须位于的位置。例如,foo在我上面的示例中,游标必须位于函数名称中的某个位置才能起作用。或者只需双击函数名称,然后按+ option+/


1
你能使它工作吗?我不能 如果你可以的话; 使用命令时您选择什么?我几乎尝试过所有选项……
困惑的Vorlon

2
我只是将光标放在方法名称中的某个位置,然后在Xcode 8中按command + option +“ /”(以及选择了“ Editor”-“ Structure”-“ Add documentation”),效果很好。到目前为止,我遇到的唯一问题是它似乎与@IBAction方法混淆。但是它与Objective-C和Swift都可以使用。如果您仍然遇到问题,并且尝试了通常的me脚程序来重新启动Xcode和/或重新启动计算机,则可能只想在此Beta版软件上发布错误报告。
罗布(Rob)2016年

2
我只是尝试重新启动,但仍然没有任何乐趣。我已经提交了错误报告。
迷糊的Vorlon

5
它实际上从Xcode 8 beta 1开始就可以使用,但是如果您使用的是El Capitan,则需要启动Xcode,让它安装所需的系统组件,然后sudo /usr/libexec/xpccachectl在Terminal中运行并重新启动Mac ,然后再运行Mac或任何其他Xcode Extensions。工作。请参阅Xcode 8发行说明。
克里斯·汉森

1
我发现它偶尔会起作用。有时效果很好,而其他时候则根本没有效果。我也没有发现原因。坦白说,当它起作用时,我发现它自动生成的内容很少(描述中的方法名称?)。对于你们中的人来说,它毫无问题,真棒。对于我们中的某些人来说,它是零星的,或者是行不通的。
劳埃德·萨金特

7

这很可能与以下事实有关:如果您的键盘需要按shift键才能使用,则所有带有'/'的热键在当前的XCode 8版本中均不起作用。

即在德语键盘上,“ /”为shift + 7,按alt + cmd + shift-7则无济于事。如果您指定cmd + shift + opt + d,则效果很好。

不幸的是,快捷方式“ ///”目前也无法使用,可能是由于旧的XCode插件VVDocumenter完全使用了此快捷方式。

很棒的功能,在苹果方面糟糕的质量检查。


Xcode 8 beta中存在此错误,但已在发行版本中修复。
埃里克·艾雅

8A218a是已发布的版本-注释快捷方式再次对我有效(不在beta中)。
埃里克·艾雅

您是否在键盘布局上不使用shift就能获得“ /”?
克劳斯·布斯

是的,我有两个键盘,一个法文Azerty键盘,在“:”上方带有“ /”,另一个是美国Qwerty键盘。两者都可以正常使用注释快捷方式。
埃里克·艾雅

好吧,这对我来说是断断续续的(美国键盘)。
劳埃德·萨金特
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.