Xcode 8.2.1 未在自动完成时显示文档描述答案

【问题标题】：Xcode 8.2.1 not showing documentation description on autocompleteXcode 8.2.1 未在自动完成时显示文档描述
【发布时间】：2017-06-09 09:17:00
【问题描述】：

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

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

有没有办法让描述显示在自动完成框中，如下图所示：

【问题讨论】：

在 Xcode 9b1 中仍然对我不起作用。看起来它不会很快起作用:(
您的问题有什么解决方案吗？我正在寻找 Apple 的 UILabel 方法，但仍然没有：/

标签： swift xcode autocomplete swift3 documentation

【解决方案1】：

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

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

因此，除非 Apple 决定改变这一点，否则恐怕无法在弹出窗口中看到您自己的。

您可以关注现有的文档集生成器（AppleDoc、Jazzy），也许它们会提供一种将文档链接到 Xcode 弹出框的方法。

请记住，在方法或属性上使用 alt + click 打开快速帮助弹出框时，您确实会看到自己的 cmets。

【讨论】：

【解决方案2】：

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

要删除此文件夹，请转到 Xcode 首选项，位置选项卡

然后单击小箭头打开一个查找器，然后手动删除该文件夹。

重启Xcode，看看现在是否正常

【讨论】：

刚刚尝试清理项目并删除派生数据文件夹。重新启动 Xcode 后，文档仍然只显示在快速帮助部分。

【解决方案3】：

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

请参考官方文档

【讨论】：