How do you document the parameters of a function’s closure parameter in Swift 3?

by

As far as I know, you can only document the closure parameters if you label them:

/// Calls bar with "Hello, world"
/// - parameter bar: A closure to call
/// - parameter theString: A string to use
func foo(bar: (theString: String) -> Void) {
    bar(theString: "Hello, world")
}

This is less than ideal: it forces you to use an argument label when you call the closure, and if there are naming conflicts, there seems no way to distinguish between the two.

Edit: As @Arnaud pointed out, you can use _ to prevent having to use the parameter label when calling the closure:

/// Calls bar with "Hello, world"
/// - parameter bar: A closure to call
/// - parameter theString: A string to use
func foo(bar: (_ theString: String) -> Void) {
    bar("Hello, world")
}

In fact, this is the only valid approach in Swift 3 because parameter labels are no longer part of the type system (see SE-0111).

More Related Contents:

  1. Migrating Swift code to Swift 3.0 LOADS of errors
  2. How can I deal with @objc inference deprecation with #selector() in Swift 4?
  3. #ifdef replacement in the Swift language
  4. How to convert a date string with optional fractional seconds using Codable in Swift?
  5. Do Swift-based applications work on OS X 10.9/iOS 7 and lower?
  6. Instantiated optional variable shows as nil in Xcode debugger
  7. SwiftUI HStack with wrap and dynamic height
  8. SwiftUI – Half modal?
  9. What are the new “for”, “at”, “in” keywords in Swift3 function declarations?
  10. Opt out of UISceneDelegate/SwiftUI on iOS
  11. Understanding SpriteKit CollisionBitMask
  12. How to update the constant height constraint of a UIView programmatically?
  13. Swift: how to use PREPROCESSOR Flags (like `#if DEBUG`) to implement API keys?
  14. Value of type ‘StorageMetadata’ has no member ‘downloadURL’
  15. How can I display my App documents in the Files app for iPhone
  16. Command failed due to signal: Abort trap: 6
  17. Swap rootViewController with animation?
  18. Use Binding with a TextField SwiftUI
  19. Programmatically detect Tab Bar or TabView height in SwiftUI
  20. Getting “file not found” in Bridging Header when importing Objective-C frameworks into Swift project
  21. How do I see which version of Swift I’m using?
  22. SwiftUI how to prevent view to reload whole body
  23. Where is Info.plist in Xcode 13? (missing, not inside project navigator)
  24. XCode 7.3.1 hangs on “copying swift standard libraries”
  25. BigInteger equivalent in Swift?
  26. How to print double quotes inside “”?
  27. Swift function object wrapper in apple/swift
  28. How do I make my exponentiation operator work with all numeric types in Swift?
  29. Can you override between extensions in Swift or not? (Compiler seems confused!)
  30. CLLocationCoordinate2D can’t be instantiated

Leave a Comment