iOS-Dokumentation für Delegierte in Swift?

Question

Wie sollten wir Delegierte in Swift dokumentieren? Wenn ich meine Dokumentation in das Protokoll lege, erscheint die Klasse leer (dokumentarisch) und umgekehrt. Und wenn ich es an beide Orte stelle, ist es mühsam zu warten.

Gibt es eine Möglichkeit, die Methode in unseren Klassen mit den dokumentierten Protokollmethoden zu verknüpfen?

Ein Beispiel für Code-Dokumentation für eine protoctol:

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


} 

In meiner Klasse:

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

Edit:

Beispiel SeeAlso:

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

} 

Answer 1

Die wichtigste Erklärung sollte die Protokollklasse sein, damit Entwickler, die Ihren Delegierten implementieren werden, wissen, was sie implementieren werden.

In Ihrer Klassendatei eine kleine Erklärung über Methode hinzufügen und den SeeAlso Tag in Ihrem Kommentar verwenden, um die Protokoll-Klasse Benennung

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

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