【问题标题】:Headerdoc with delegate Protocols - Swift and xcode 7.2带有委托协议的 Headerdoc - Swift 和 xcode 7.2
【发布时间】:2016-05-12 00:27:09
【问题描述】:

我已经定义了一个协议,并将 HeaderDoc 文档添加到该协议中的方法中。当我 Option+Click 方法时它正确显示:

但是,当我在实现此协议的控制器中按 Option+单击实现时,文档未显示:

我的期望是我为协议编写的文档会显示在控制器中,类似于 Apple 的文档:

如何让我的协议文档在其他地方可见?

【问题讨论】:

  • 看起来您记录了一种方法,但随后尝试为另一种方法调出文档。
  • 我上传了错误的图片。谢谢佩塔:D

标签: xcode swift appledoc headerdoc


【解决方案1】:

如果您在协议扩展中记录协议的方法实现,那么该文档将在符合协议的任何类型中可见。

如果您省略扩展程序的文档,则协议中的 canDo 文档不会出现在协议本身之外的任何其他地方,正如您所注意到的那样。

protocol Doable {
    /// Does something
    func canDo()
}

extension Doable {
    /// Does something really well
    func canDo() {
        print("Did it!")
    }
}

struct Task: Doable {
    init() {
        canDo()
    }
}

【讨论】:

  • 谢谢佩塔!很遗憾,我们需要实现一个扩展才能看到协议文档。也许将来它会在没有它的情况下工作。 :)
  • @VictorTavares 你可以随时file a bug report and/or a feature request!
猜你喜欢
  • 2021-03-14
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多