XCode 8.2.1未显示有关自动完成的文档说明

我在向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 
}

文档显示为预计在快速帮助窗口，但该说明并不在代码自动完成的窗口显示。

有没有办法让自动完成框中显示的说明，如下图所示：

谢谢。

来源

2017-01-24 glv19

在Xcode 9b1中仍然不适用于我。看起来它不会很快工作:( –

-1

对我来说，解决这个问题的最好方法是清理项目Shift + Command + K，如果这不起作用，删除Derived Data文件夹是个上帝的主意。

要删除这个文件夹去Xcode的喜好，位置标签

，并点击小箭头打开取景器，并手动删除该文件夹。

重新启动的Xcode，并检查是否是现在工作

来源

2017-01-24 14:30:14

只是尝试清理项目并删除Derived Data文件夹。重新启动Xcode后，文档仍然只显示在快速帮助部分。 – glv19

-2

https://developer.apple.com/library/content/documentation/Xcode/Reference/xcode_markup_formatting_ref/MarkupFunctionality.html#//apple_ref/doc/uid/TP40016497-CH54-SW1

请参考官方文档

来源

2017-01-25 02:52:42

你是对的，你添加到你的方法和属性上的说明不再出现在popover中。

如上所述，您只能看到Apple自己的方法和属性的描述。
原因是Xcode并没有从它们的类中解析这些文件，而是从一个单独的文档集（你可以在Xcode的Help/Documentation and API reference标签中找到）中解析它们。因此，除非苹果决定改变这种情况，否则恐怕在弹出窗口中看不到你自己的东西。

您可以留意现有的文档集生成器（AppleDoc,Jazzy），也许他们会提供一种将文档链接到Xcode popover的方法。

记住与ALT +点击上方法或属性打开快速帮助酥料饼的时候，你看到自己的意见。

来源

2017-05-15 14:29:23 Thomas

XCode 8.2.1未显示有关自动完成的文档说明

回答

相关问题