如何用参数记录枚举案例?

时间:2018-10-07 14:48:42

标签: swift enums code-documentation

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

例如这些代码注释:

/// Various coffee types.
enum Coffee {

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

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

enter image description here

那么正确的标记是什么?

1 个答案:

答案 0 :(得分:2)

obj.id

单击/// Various coffee types. enum Coffee { /// A Cappuccino. /// - cream: Is true if cream is added. case cappuccino(cream: Bool) } 时它将显示为项目符号,但是如果单击cappuccino参数则不会显示。但是我想这已经足够了。 >