swift - 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

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

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

因此，除非 Apple 决定更改此设置，否则恐怕无法在弹出窗口中看到您自己的内容。

您可以关注现有的文档集生成器(AppleDoc、Jazzy)，也许他们会提供一种将其文档链接到 Xcode 弹出窗口的方法。

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