Swift 中代表的 iOS 文档？

Question

我们应该如何记录 Swift 中的委托(delegate)？如果我将我的文档放在协议(protocol)中，该类将看起来是空的(文档方面)，反之亦然。如果我把它放在两个地方，维护起来会很麻烦。

是否有某种方法可以将我们类中的方法链接到记录的协议(protocol)方法？

协议(protocol)的代码文档示例:

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

编辑:

另见示例:

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

}

Answer 1

主要的解释应该放在协议(protocol)类上，以便将实现您的委托(delegate)的开发人员知道将要实现什么。

在你的类文件中添加一些关于方法的解释，并在命名协议(protocol)类的注释中使用 SeeAlso 标签

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

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