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 { ... }

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

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

它只是方便快速帮助文档的编写。

---

请注意，虽然此行为随着时间的推移发生了一些变化，但当您尝试执行此操作时，Xcode 可能会特别注意光标必须位于的位置。例如，光标必须位于函数名称中的某处，在我上面的示例中，foo 才能起作用。或者只需双击函数名称，然后按 ⌘+option+/

---

您询问此功能是否会取代 Jazzy 等工具。

不，它不会取代 Jazzy 或类似工具。除此之外，Jazzy 从这个内联文档创建独立的 HTML 文档。因此，这只是您是否出于任何原因需要 Jazzy 的这些独立输出的问题。如果是这样，请将 Jazzy(或类似工具)与此集成文档结合使用。如果不是(即，您只是在 Xcode IDE 中查找文档)，则不需要 Jazzy。