Swift3中多返回值函数的文档注释

Question

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

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

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

param1

创建param2和retA的语句。那么，如何为retB和/// - Returns: /// - retA: xxx /// - retB: xxx 创建语句？如果我使用

retA

快速帮助只需将retB和param1视为两个Markdown项目，但无法与param2和"target": "es6" 获得相同的效果。

Answer 1

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

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

  

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

     

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

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

您可能会更好运，只需使用markdown格式化返回，以便为其提供更好的格式。