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

Question

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

例子：

/** 
Foo 

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

这就是表明，如果我option + click在Xcode在上面的函数来查看文档：

苹果的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 
}