如何在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
}

显示结果:

Answer 2

看起来- Parameter效果很好。

enum Vegetable {
    
    /// Potato.
    /// - Parameter variety: Variety of potato.
    /// - Parameter mass: Mass of a potato in kilograms.
    case potato(variety: String, mass: Float)
}