例如,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
当成两个Markdown项,不能用param1
和param2达到同样的效果
。
最佳答案
我不相信有可能得到你想要做的事情。
这是因为虽然您可以使用多个返回类型,但它在内部转换为一个元组(这是一个单一的值)。考虑到这一点以及 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.
注意参数如何显示为复数,而返回值是单个值(在本例中为元组)。
您可能会更幸运,只需使用 markdown 格式化返回值以使其具有更好的格式。
关于swift - Swift3 中多返回值函数的文档注释,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/42289204/