Xcode 8自动生成的快速帮助文档
H4H*_*ugo 81 xcode swift xcode8
在Xcode 8中宣布的新功能中,我们可以看到
"自动生成快速帮助文档":
这是我们可以从NSHipster的这篇文章中学到的手动代码文档的结尾吗？
有人可以勾勒出这个新功能的优点和缺点吗？它会取代像Jazzy这样的工具吗？
我找不到有关新功能的更多信息.
Rob*_*Rob 192
他们只是说在Xcode 8中你可以选择这样的方法:
func foo(bar: Int) -> String { ... }
然后按command+ option+ /或从Xcode的"编辑器"菜单中选择"结构" - "添加文档",它将为您生成以下注释模板:
/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>
它只是简化了快速帮助文档的编写.
请注意,虽然此行为随着时间的推移有所改变,但当您尝试执行此操作时,Xcode可能特别关注光标所在的位置.例如,光标必须位于函数名称的某个位置,foo在上面的例子中,为此起作用.或者只需双击功能名称,然后按command+ option+/
- 它实际上是从Xcode 8 beta 1开始工作,但是如果你使用的是El Capitan,你需要启动Xcode,让它安装所需的系统组件,然后在终端中运行`sudo/usr/libexec/xpccachectl`并重启你的它之前的Mac或任何其他Xcode Extensions都可以使用.请参阅Xcode 8发行说明. (5认同)
- 它实际上还没有工作.这是一个已知的错误. (3认同)
- 我只是将光标放在方法名称的某处,然后在Xcode 8中按下命令+选项+"/"(以及选择"编辑器" - "结构" - "添加文档"),它工作正常.到目前为止我遇到的唯一问题是它似乎与`@ IBAction`方法相混淆.但它适用于Objective-C和Swift.如果您仍然遇到问题,并尝试了重新启动Xcode和/或重新启动计算机的常见程序,您可能只想发布此测试版软件的错误报告. (2认同)
- 我只是尝试重新启动,但仍然没有快乐.我已经提交了一份错误报告. (2认同)
这很可能与以下事实有关：如果您的键盘需要按shift键才能将所有带有'/'的热键在当前的XCode 8版本中不起作用。
即在德语键盘上，“ /”是shift + 7，按alt + cmd + shift-7则无济于事。如果您指定cmd + shift + opt + d，则效果很好。
不幸的是，快捷方式“ ///”目前也无法使用，可能是由于旧的XCode插件VVDocumenter完全使用了此快捷方式。
很棒的功能，在苹果方面糟糕的质量检查。