Xcode - Добавить пользовательскую документацию для Swift Closure

Вопрос:

  • Какой правильный формат для добавления документации (используя встроенную функциональность, а не сторонний) в пользовательский Swift закрытие в Xcode 8?
  • Не могли бы вы предоставить ссылку на документацию Apple для ссылки?
  • Как указать closureparameters?
  • Как указать closurereturn type?

Пример:

struct S1 {

    /// This block is executed after completion
    var completion : (String, Int) -> (Bool)
}

Замечания:

Xcode 8 имеет встроенную функциональность для добавления документации в пользовательский код.

Это можно сделать, выполнив одно из следующих действий:

  • Command + Option + Click по коду

  • Наведите курсор на код и Editor > Structure > Add documentation

1 ответ

Решение

Ссылка:

Временное решение:

Если эти теги не поддерживаются для данного местоположения, единственный возможный обходной путь кажется прямо сейчас:

struct S1 {

    /// description
    ///
    /// __returns__
    /// blah blah
    ///
    /// __parameters__
    /// blah blah
    var completion : (String, Int) -> (Bool)
}
Другие вопросы по тегам