2016-09-24 12 views
8

Swift 3の列挙型の関連値に記述を追加する方法はありますか?私は- Parameters:を使用してみましたSwiftの列挙型関連値にドキュメントを追加する方法

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) 
} 

、それ:私は、彼らがXcodeの8で、関数のパラメータのために行うよう

は、これは私の列挙され、それらは、シンボルドキュメントポップアップ(オプション+クリック)に表示したいです列挙型では機能しません。

答えて

4

このようにそれを実行します。

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

    /// enum2 Description 
    case enum2 
} 

表示結果: enter image description here

関連する問題