Среди новых функций, анонсированных в 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+/
@IBActionметодами. Но он отлично работает как с Objective-C, так и со Swift. Если у вас все еще возникают проблемы и вы пробовали обычную неудачную процедуру перезапуска Xcode и / или перезагрузки вашего компьютера, вы можете просто опубликовать отчет об ошибке в этой бета-версии программного обеспечения.
sudo /usr/libexec/xpccachectlв Терминале и перезагрузить Mac, прежде чем он или любые другие расширения Xcode будут Работа. См. Примечания к выпуску Xcode 8.
Скорее всего, это связано с тем, что ВСЕ горячие клавиши с символом '/' не работают в текущей сборке XCode 8, если ваша клавиатура требует нажатия клавиши Shift для ее получения.
Т.е. на немецкой клавиатуре '/' - это shift + 7, нажатие alt + cmd + shift-7 ничего не делает. Если вы назначите ie cmd + shift + opt + d, он будет работать нормально.
Ярлык '///', который, к сожалению, сейчас также не работает, вероятно, связан со старым плагином XCode VVDocumenter, который использовал именно этот ярлык.
Отличная функция, плохой контроль качества со стороны Apple.