如何用参数记录枚举案例？ [复制]答案

【问题标题】：How to document an enum case with parameters? [duplicate]如何用参数记录枚举案例？ [复制]
【发布时间】：2018-10-07 14:48:41
【问题描述】：

给定一个enum 有一个带有参数的case，我如何记录这些参数？

例如这些代码cmets：

/// Various coffee types.
enum Coffee {

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

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

那么正确的标记是什么？

【问题讨论】：

谢谢，确实是重复的。因此我应该删除这个问题吗？

标签： swift enums code-documentation

【解决方案1】：

/// Various coffee types.
enum Coffee {

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

当你点击 cappuccino 时它会显示为一个项目符号，但如果你点击 cream 参数就不会显示它。但我想它已经足够好了。..

【讨论】：