Comment documenter les paramètres optionnels de la fonction de fermeture ?

Question

Comment documenter les paramètres d'un paramètre de fermeture optionnel d'une fonction en Swift 4 ?

Supposons que vous ayez une méthode qui prenne en paramètre une fermeture optionnelle. Par exemple, une méthode qui prend une fermeture optionnelle en paramètre,

/// 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
}

Le paramètre aClosureParameter ne serait pas documenté. Comment documenter les paramètres de fermeture optionnels ?

Answer 1

Je ne peux pas dire si c'est intentionnel ou si c'est un bogue, mais une solution de contournement est possible. de déclarer le type de paramètre en utilisant Optional au lieu de ? :

/// 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
}