修复Xcode快速帮助检查器的“参数”部分中的“无描述”

时间:2019-07-11 16:23:03

标签: swift xcode

我在文档注释中使用标记,以便在Xcode的快速帮助检查器中创建呈现的文档。

在“快速帮助”检查器的“参数”部分中,即使我已经提供了所有参数的描述,但渲染器仍为名为“-”的参数添加了“无描述”行,并且没有名为“ -”。

这是代码:

struct Carrot {
    /**
     Picks carrots.

     - Parameters:
        - qty: how many carrots to pick
        - queue: The dispatch queue on which to run `done`.
        - done: Code to run when done.
     */
    public static func pick(_ qty: Int,
                            queue: DispatchQueue = DispatchQueue.main,
                            done: @escaping ([Carrot]) -> Void) {
        // Code goes here.
    }
}

代码的屏幕快照,因为这与我的代码在Xcode中的显示方式有关:

enter image description here

以下是快速帮助中呈现的帮助:

enter image description here

请注意“参数”部分下的最后一个条目:“无描述”。我该如何解决?

我以为这个问题可能是由于没有对闭包输入参数进行描述,但是如果这是原因,我一直无法找出要使用的正确语法。

唯一的documentation I can find on Xcode's doc comment markup被“存档”,但Xcode 10.2似乎仍然很荣幸。但是,我在那些文档中找不到任何可帮助我解决此问题的东西。

0 个答案:

没有答案