XCode 8.2.1没有显示自动完成的文档描述

Question

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

文档在快速帮助窗口中按预期显示，但描述未在代码自动完成窗口中显示。

有没有办法让说明显示在自动填充框中，如下图所示：

谢谢。

Answer 1

你是对的，你添加到方法和属性顶部的描述不再出现在popover中。

如上所述，您只能看到Apple自己的方法和属性的描述 原因是Xcode不从它们的类中解析这些，而是​​从单独的文档集中解析（可以在Xcode的Help/Documentation and API reference选项卡中找到）。

因此，除非Apple决定改变这一点，否则我不敢在popover中看到你自己。

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

请注意，在方法或媒体资源上使用 alt + 点击打开快速帮助文件时，您确实会看到自己的评论。

Answer 2

对我而言，解决此问题的最佳方法是清除项目Shift + Command + K，如果这不起作用，删除Derived Data文件夹是个明智之举。

要删除此文件夹，请转到Xcode偏好设置，位置标签

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

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

Answer 3

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

请参阅官方文档