2016-02-03 4 views
1

Я определил протокол и добавил документацию HeaderDoc к методу в этом протоколе. Он отображается правильно, когда Option + Click метод:Headerdoc с делегатом Протоколы - Swift и xcode 7.2

Image of documentation in the protocol

Однако, когда я Option + Click реализации в контроллере, который реализует этот протокол, документация не отображается:

enter image description here

Мое предположение заключается в том, что документация, которую я написал для протокола, будет отображаться в контроллере, аналогично документации от Apple:

enter image description here

Как получить, чтобы моя протокольная документация была видимой в другом месте?

+1

Похоже, вы документированы один метод, но затем попытался поднять документы для другого метода. –

+0

Я загрузил неправильное изображение. Спасибо Петах: D –

ответ

2

Если вы документируете реализацию метода протокола в расширении протокола, документация будет видна в любом типе, соответствующем протоколу.

Если вы опускаете документацию по расширению, документация по протоколу 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

+0

Спасибо, Петах! Печально, что нам нужно внедрить расширение, чтобы иметь возможность видеть документацию протокола. Возможно, в будущем он будет работать без него. :) –

+0

@VictorTavares Вы всегда можете [указать отчет об ошибке и/или запрос функции] (https://bugreport.apple.com/)! –

Смежные вопросы