如何将文档添加到Swift的enum关联值中

有没有方法可以将描述添加到Swift 3中关联的enums值？我希望他们能够在符号文档弹出式窗口（选件+点击）显示出来，就像他们在Xcode中8如何将文档添加到Swift的enum关联值中

函数的参数做，这是我的枚举：

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:，但它在枚举中不起作用。

来源

2016-09-24 WetFish

做这样的：

/// Enum Description 
enum Enum { 
    /// enum1 Description 
    /// - value1: value1 Description 
    /// - value2: value2 Description 
    case enum1(value1: Int, value2: String) 

    /// enum2 Description 
    case enum2 
}

显示结果：

来源

2017-03-03 07:05:07 jqgsninimo

如何将文档添加到Swift的enum关联值中

回答

相关问题