什麼是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 
}