Swiftの代理人向けのiOSドキュメントですか？

Question

Swiftで代理人をどのように文書化すればよいですか？私がドキュメントにプロトコルを入れると、クラスは空になり（ドキュメントが賢明）、その逆になります。私はそれを両方の場所に置くと、維持するための面倒になります。

私たちのクラスのメソッドをドキュメント化されたプロトコルメソッドにリンクする方法はありますか？

protoctolのためのコードのドキュメントの例：私のクラスで

protocol SomeDelegate: class { 
    /** 
    Awesome method 
    - parameters: 
    - oneParam: This works great 
    */ 
    func testAwesome(oneParam: Int) 


} 

：

class AwesomeClass: SomeDelegate { 
    /// Should we just make a little note? Or what does apple expect? 
    func testAwesome(oneParam: Int) { 
    // implement stuff 
    } 
} 

編集：SEEALSOの

例：

/// - Note: Implementation of Something, (note this works) 
/// - SeeAlso: Test (note this does not show when holding alt) 
func doneWithSomething() { 

} 

Answer 1

主な説明は、デリゲートを実装する開発者が実装しようとしていることを知っているために、プロトコルクラス上にあるべきです。あなたのクラスファイルで

方法について少し説明を追加し、プロトコルクラスに

class AwesomeClass: SomeDelegate { 
    /* 
     Should we just make a little note? Or what does apple expect? 

     - SeeAlso: `SomeDelegate` 
    */ 
    func testAwesome(oneParam: Int) { 
    // implement stuff 
    } 
}