Xcode 8 автоматично згенерована документація з швидкої довідки

Серед нових функцій, анонсованих у 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 для її отримання.

Тобто на німецькій клавіатурі '/' має значення shift + 7, натискання alt + cmd + shift-7 нічого не робить. Якщо ви призначите, тобто cmd + shift + opt + d, це працює чудово.

Ярлик '///', який, на жаль, також зараз не працює, можливо, пов'язаний зі старим плагіном XCode VVDocumenter, який використовував саме цей ярлик.

Чудова функція, паршива перевірка якості на стороні Apple.