如何在Swift中为枚举关联值添加文档

Question

有没有办法在Swift 3中为相关的枚举值添加描述？我希望它们出现在符号文档弹出窗口（选项+单击）中，就像它们对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
}

显示结果：