Swift3 中多 return 值函数的文档注释

Question

Swift3 支持具有多个 return 值的函数，例如

func foo(param1: Int, param2: Double) -> (retA: String, retB: [Int]) {
    // ...
}

在为该函数创建文档注释时，我们可以使用

/// function `foo` .....
/// 
/// - Parameters:
///   - param1: xxx
///   - param2: xxx

创建 param1 和 param2 的语句。那么，如何为retA和retB创建语句呢？如果我使用

/// - Returns:
///   - retA: xxx
///   - retB: xxx

快捷帮助只是把retA和retB当成两个Markdown项，无法达到param1和param2的效果。

Answer 1

我不相信有可能得到你想要做的事情。

这是因为虽然您可以使用多个 return 类型，但它在内部转换为一个元组（这是一个单一的值）。考虑到这一点以及 quickhelp documentation 说的事实：

The Parameters section lists the parameters for a method or function.

The Returns section documents any return value for a method or function.

注意参数如何显示为复数，而 return 是单个值（在本例中为元组）。

你可能会更幸运，只需使用 markdown 格式化 return 以赋予它更好的格式。

Documentation comment for multi-return-value functions in Swift3