前端之家收集整理的这篇文章主要介绍了
swift – XCode 8.2.1没有显示自动完成的文档描述,
前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我在XCode 8.2.1中向我的
代码添加文档时遇到了问题.
这是我的代码:
/// Test documentation method
///
/// - Parameter string: The input string
/// - Returns: The output bool
func testMethod(string:String) -> Bool {
if string == "YES" {
return true
}
return false
}
文档在快速帮助窗口中按预期显示,但说明未显示在代码自动完成窗口中.
有没有办法让描述显示在自动完成框中,如下图所示:
谢谢.
你是对的,你
添加到
方法和
属性顶部的描述不再出现在popover中.
如上所述,您只能看到Apple自己的方法和属性的描述.
原因是Xcode不从它们的类中解析这些,而是从单独的文档集中解析(可以在Xcode的帮助/文档和API参考选项卡中找到).
因此,除非Apple决定改变这一点,否则我不敢在popover中看到你自己.
您可以关注现有的文档集生成器(AppleDoc,Jazzy),也许他们会提供一种方法将他们的文档链接到Xcode的popover.
请记住,在打开方法或属性的alt单击时打开快速帮助弹出窗口时,您确实看到了自己的注释.
原文链接:https://www.f2er.com/swift/320159.html