文檔註釋

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格式化返回以給它一個更好的格式。