Weekly Swift articles, podcasts and tips by John Sundell.

Referencing either external or internal parameter names when writing docs

Published on 22 Jan 2017

You can reference either external or internal parameter names when writing Swift documentation - and they get parsed the same:

// EITHER:

class Foo {
    /**
    *   - parameter string: A string
    */
    func bar(with string: String) {}
}

// OR:

class Foo {
    /**
    *   - parameter with: A string
    */
    func bar(with string: String) {}
}