如何记录带有参数的枚举案例?

How to document an enum case with parameters?

给定一个 enum 有一个 case 带参数,我如何记录这些参数?

例如这些代码注释:

/// Various coffee types.
enum Coffee {

  /// A Cappuccino.
  /// - parameters:
  ///   - cream: Is true if cream is added.
  case cappuccino(cream: Bool)
}

生成缺少 cream 参数文档的弹出窗口。

那么正确的标记是什么?

/// Various coffee types.
enum Coffee {

    /// A Cappuccino.
    /// - cream: Is true if cream is added.
    case cappuccino(cream: Bool)
}

当您点击 cappuccino 时它会显示为项目符号点,但如果您点击 cream 参数则不会显示。但我想这已经足够好了。