文档注释

Question

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

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两个项目降价，并不能得到与param1和param2同样的效果。

Answer 1

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

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

参数部分列出了方法或函数的参数。

Return部分记录方法或函数的任何返回值。

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

你可能会有更好的运气，简单地使用markdown格式化返回以给它一个更好的格式。