带有委托协议的Headerdoc - Swift和xcode 7.2

时间:2016-02-03 00:24:35

标签: xcode swift appledoc headerdoc

我已经定义了一个协议,并在此协议中的方法中添加了HeaderDoc文档。当我选择+单击方法时,它正确显示:

Image of documentation in the protocol

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

enter image description here

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

enter image description here

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

1 个答案:

答案 0 :(得分:3)

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

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

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

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

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

enter image description here