【问题标题】:Xcode 8 auto-generated quick help documentationXcode 8 自动生成的快速帮助文档
【发布时间】:2016-10-30 11:46:22
【问题描述】:

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

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

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

有人能概括一下这个新功能的优缺点吗? Does it replace tools like Jazzy?

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

【问题讨论】:

  • @Rob:任何想法我如何才能了解它的外观,而无需安装 Xcode 8 bêta 并在之后立即卸载它(无权将其安装在我工作的 Mac 上)
  • 它在一些 WWDC 2016 视频中得到了展示。
  • 您可以在 37:00 观看视频中的演示 - 但是我无法让它实际工作!我尝试过使用 swift 和 obj-c 并选择了函数的各个不同部分。

标签: xcode swift xcode8


【解决方案1】:

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

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

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

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

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


注意,虽然这种行为随着时间的推移而发生了一些变化,但当您尝试这样做时,Xcode 可能会特别注意光标必须位于的位置。例如,光标必须位于函数名称中的某个位置,在我上面的示例中,foo 才能工作。或者直接双击函数名然后按+option+/


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

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

【讨论】:

  • 你能让它工作吗?我不能。如果你可以的话;使用命令时选择什么?我几乎尝试了所有选项...
  • 我只是将光标放在方法名称中的某个位置,然后在 Xcode 8 中按 command+option+"/" (以及选择了“编辑器”-“结构”-“添加文档”)和它工作正常。到目前为止,我遇到的唯一问题是它似乎与 @IBAction 方法混淆了。但它适用于 Objective-C 和 Swift。如果您仍然遇到问题并且尝试了重启 Xcode 和/或重启机器的常规蹩脚程序,您可能只想发布关于此测试版软件的错误报告。
  • 我刚刚尝试重新启动,但仍然没有任何乐趣。我已提交错误报告。
  • 它实际上从 Xcode 8 beta 1 开始工作,但如果你使用 El Capitan,你需要启动 Xcode,让它安装所需的系统组件,然后在终端中运行 sudo /usr/libexec/xpccachectl 并在 Mac 或任何其他 Xcode 扩展工作之前重新启动你的 Mac。请参阅 Xcode 8 发行说明。
  • 我发现它偶尔会起作用。有时效果很好,有时根本不行。我也没有发现原因。坦率地说,当它起作用时,我发现它自动生成的东西相当稀疏(描述中的方法名称?)。对于你们这些人来说,它没有问题,太棒了。对于我们中的一些人来说,它是零星的,或者根本不起作用。
【解决方案2】:

这很可能与以下事实有关

即在德语键盘上,'/' 是 shift+7,按 alt+cmd+shift-7 不起作用。如果你指定,即 cmd+shift+opt+d,它工作得很好。

快捷方式'///',不幸的是现在也不起作用,可能是由于旧的 XCode 插件 VVDocumenter 使用了这个快捷方式。

很棒的功能,Apple 方面糟糕的 QA。

【讨论】:

  • Xcode 8 beta 中存在这个错误,但已在发布版本中修复。
  • 8A218a 是已发布的版本 - 评论快捷方式再次对我有用(在测试版中没有)。
  • 您是否使用键盘布局,在不使用 shift 的情况下获得“/”?
  • 是的,我有两个键盘,一个是法语 Azerty,一个是在“:”上带有“/”的键盘,一个是美国 Qwerty。两者都适用于评论快捷方式。
  • 嗯,对我来说是断断续续的(美式键盘)。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2017-06-11
  • 2011-05-16
  • 2021-11-18
  • 2011-09-12
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多