如何將文檔添加到Swift的enum關聯值中

Question

有沒有方法可以將描述添加到Swift 3中關聯的enums值？我希望他們能夠在符號文檔彈出式窗口（選件+點擊）顯示出來，就像他們在Xcode中8

函數的參數做，這是我的枚舉：

enum Result { 
    /** 
    Request succeeded. 

    - Parameters: 
     - something: Some description. 
     - otherThing: Other description. 
    */ 
    case Success(something: Int, otherThing: Int) 

    /** 
    Request failed. 

    - Parameter error: Error. 
    */ 
    case Error(error: Error) 
} 

我試着用- Parameters:，但它在枚舉中不起作用。

Answer 1

做這樣的：

/// Enum Description 
enum Enum { 
    /// enum1 Description 
    /// - value1: value1 Description 
    /// - value2: value2 Description 
    case enum1(value1: Int, value2: String) 

    /// enum2 Description 
    case enum2 
} 

---

顯示結果：