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

Question

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

示例：

/**
 Foo

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

如果我在 Xcode 中 option + click 上面的函数查看文档，这就是显示的内容：

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

Answer 1

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

/**
 Foo

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

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

What is the markup format for documentation on the parameters of a block in Swift?

swift

xcode

documentation

markdown

markup