我该如何写Swift文档注释的闭包参数?

时间:2019-01-03 17:19:36

标签: swift xcode markup

当我为带有一个具有参数的闭包参数的Swift函数编写文档注释时,Xcode中的快速文档会显示一个带有闭包参数名称的表:

/**
 * - parameters:
 *   - completion: Called after `myFunc` completes
 */
 func myFunc(completion: @escaping (_ p1: String, _ p2: String?) -> Void) {

Generated quick docs

我一直无法弄清楚如何为闭包参数添加描述。我尝试过

/**
 * - parameters:
 *   - completion:
 *     - parameters:
 *       - p1: test

/**
 * - parameters:
 *   - completion:
 *     - parameter p1: test

,也不会在表中添加任何文本。有人知道该怎么做吗?

0 个答案:

没有答案