如何在iOS swift中使用完成处理程序正确记录方法

Question

我正在记录我公司的iOS应用程序的代码,现在我转向了具有完成处理程序的方法.是否有记录完成处理程序的特定方法,或者我应该将其作为参数的一部分？

例如:

/**
Description
- Parameters:
     - parameter1: description
     - parameter2: description
     - completion: description
*/

这是正确的方式还是有另一种更好的方法？或者它应该在文档的"返回"部分？

谢谢

Answer 1

由于之前接受的答案无法在Swift 3下编译(函数类型不能有参数标签.)我想添加更新的答案:

/**
Find User ID from Request
- Parameter from: The request containing relevant information.
- Parameter completionHandler: The callback called after retrieval.
- Parameter userId: The retrieved user id.
*/
static func extractUserId(from: RouterRequest, completionHandler: (_ userId: String) -> Void)

结果

对我来说看起来不错!