如何记录可选闭包函数参数？

Question

如何在Swift 4中记录函数可选闭包参数的参数？

假设您有一个接受可选闭包作为参数的方法。例如，

/// An example function.
/// Documentation goes here.
/// 
/// - Parameters:
///   - optionalClosure:    An optional closure.
///   - aClosureParameter:  This will not be displayed.
func exampleMethod(optionalClosure: ((_ aClosureParameter: Bool) -> Void)?) {
    // Do something
}

不会被记录。如何记录可选闭包参数？

- Jinyeong

Answer 1

我无法确定这是故意的还是一个错误，但一个解决方法是使用 Optional 而不是 ? 来声明参数类型：

/// An example function.
/// Documentation goes here.
///
/// - Parameters:
///   - optionalClosure:    An optional closure.
///   - aClosureParameter:  This **will** be displayed.
func exampleMethod(optionalClosure: Optional<(_ aClosureParameter: Bool) -> Void>) {
    // Do something
}

- Martin R