Swift 中关于块参数的文档的标记格式是什么？

Question

如果您为文档添加标记，则 Swift 中的块参数会显示一个块参数表，但我不知道如何填写此表。我在Xcode markup reference formatting 中搜索过它，但我找不到任何东西。

例子：

/**
 Foo

 - parameter completion: A block to execute
 */
func foo(completion: (Bool) -> Void) {
    // do something
}

如果我在 Xcode 中 option + click 在上面的函数上查看文档，就会出现这种情况：

Apple 的 API 显示填写的完成块参数表。这是 CloudKit API 文档视图的示例：

Answer 1

您必须为参数命名，但在其前面加上下划线：

/**
 Foo

 - parameter completion: A block to execute
 - parameter aflag: Some Bool flag
 */
func foo(completion: (_ aflag: Bool) -> Void) {
    // do something
}