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

Question

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

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

这是我们can learn on this article from NSHipster手动代码文档的结尾吗？

有人可以勾勒出这个新功能的优点和缺点吗？ Does it replace tools like Jazzy？

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

Answer 1

这是指Xcode 8（及更高版本）功能，您可以在其中选择如下方法：

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

...然后按⌘+选项+ /（或从Xcode的“编辑器”菜单中选择“结构”»“添加文档”），它将为您生成以下注释模板：

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

它只是简化了快速帮助文档的编写。

---

请注意，虽然此行为随着时间的推移有所改变，但当您尝试执行此操作时，Xcode可能特别关注光标所在的位置。例如，光标必须位于函数名称中的某个位置，在上面的示例中为foo，以便工作。或者只需双击功能名称，然后按⌘+选项+ /

Answer 2

这很可能与所有带有'/'的热键在当前XCode 8版本中不起作用的事实有关，如果你的键盘需要按shift来获取它。

即在德国键盘上'/'是shift + 7，按alt + cmd + shift-7不做任何事情。如果你指定了cmd + shift + opt + d，它就可以了。

快捷方式'///'，遗憾的是现在也无法正常工作，可能是由于旧的XCode插件VVDocumenter，它使用了这个快捷方式。

很棒的功能，苹果方面糟糕的质量保证。