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

Xcode 8 auto-generated quick help documentation

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

"Auto-generate Quick Help documentation" :

像我们这样的手动代码文档就这样结束了吗can learn on this article from NSHipster

谁能概述一下这个新功能的优缺点? Does it replace tools like Jazzy ?

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

这指的是 Xcode 8(及更高版本)功能,您可以在其中 select 像这样的方法:

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

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

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

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


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


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

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

这很可能是因为所有带“/”的热键在当前 XCode 8 版本中都不起作用,如果您的键盘需要按 shift 键才能使用。

即在德语键盘上,'/' 是 shift+7,按 alt+cmd+shift-7 没有任何作用。如果你分配,即 cmd+shift+opt+d,它工作得很好。

快捷方式“///”,不幸的是现在也不能用,可能是因为旧的 XCode 插件 VVDocumenter,它使用了这个快捷方式。

很棒的功能,Apple 方面的质量检查很糟糕。