swift - Swift 中 block 参数文档的标记格式是什么？

Question

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

示例:

/**
 Foo

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

如果我在 Xcode 中对上面的函数option + click 来查看文档，会显示以下内容:

Apple 的 API 显示已填写的完成 block 参数表。这是 CloudKit API 文档 View 的示例:

Answer 1

你必须给参数一个名字，但在它前面加一个下划线:

/**
 Foo

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