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

los*_*hua 5 documentation markup markdown xcode swift

如果为文档添加标记,Swift中块的参数会显示一个块参数表,但我无法弄清楚如何填写此表.我在Xcode标记引用格式中搜索了它,但我找不到任何内容.

例:

/**
 Foo

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

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

Xcode文档视图的功能图像

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

Xcode文档视图的功能图像

Mik*_*rne 18

您必须为参数指定名称,但在其前面加上下划线:

/**
 Foo

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

在此输入图像描述