Среди новых функций, объявленных в Xcode 8, мы можем видеть
"Автоматическая генерация быстрой справочной документации":
Является ли это завершением документации по ручному коду, как мы можем узнать по этой статье из NSHipster?
Может ли кто-нибудь описать плюсы и минусы этой новой функции? Он заменяет такие инструменты, как Jazzy?
Я не мог найти больше информации о новой функции.
Это относится к функции Xcode 8 (и позже), где вы можете выбрать метод, подобный этому:
func foo(bar: Int) -> String { ... }
... и затем нажмите ⌘ + option + / (или выберите "Структура" "" Добавить документацию "из меню" Редактор "Xcode), и он сгенерирует для вас следующий шаблон комментариев:
/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>
Это просто облегчает написание документации для быстрой справки.
Обратите внимание, что хотя это поведение немного изменилось с течением времени, Xcode может указывать, где должен находиться курсор, когда вы пытаетесь это сделать. Например, курсор должен находиться где-то в имени функции, foo в моем примере выше, чтобы это работало. Или просто дважды щелкните по имени функции и затем нажмите ⌘ + option + /
Это скорее всего связано с тем, что ВСЕ горячие клавиши с "/" не работают в текущей сборке XCode 8, если на клавиатуре требуется нажать shift, чтобы получить ее.
т.е. на немецкой клавиатуре '/' сдвиг + 7, нажатие alt + cmd + shift-7 ничего не делает. Если вы назначаете, т.е. Cmd + shift + opt + d, он работает просто отлично.
Ярлык "///", который, к сожалению, также не работает прямо сейчас, вероятно, связан с старым плагином VCDocumenter XCode, который использовал именно этот ярлык.
Отличная функция, паршивая QA со стороны Apple.