Cách thêm tài liệu vào các giá trị liên quan đến enum trong Swift

Question

Có cách nào để thêm mô tả vào các giá trị liên quan của enums trong Swift 3 không? Tôi muốn họ xuất hiện trong tài liệu biểu tượng cửa sổ bật lên (tùy chọn + click), giống như họ làm cho các thông số chức năng trong Xcode 8.

Đây là enum của tôi:

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) 
} 

Tôi đã cố gắng sử dụng - Parameters:, nhưng nó không hoạt động trong enums.

Answer 1

Làm điều đó như thế này:

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

    /// enum2 Description 
    case enum2 
} 

---

Hiện kết quả: