Авто генерировать комментарий метода в Xcode - PullRequest
35 голосов
/ 21 января 2012

Есть ли способ в Xcode для генерирования комментария метода, автоматически подобного тому, что вы делаете в Eclipse для комментариев Javadoc.

Например, нажмите, вы можете нажать / ** за одну строку до объявления метода, и eclipse автоматически сгенерирует скелет комментариев метода.

Ответы [ 5 ]

82 голосов
/ 19 октября 2016

Вы можете использовать ярлык для создания документа заголовка:

+ + /

где
= Команда
= Опция (Alt на Windows-совместимых клавиатурах)

27 голосов
/ 21 января 2012

Для этого вы можете использовать библиотеку фрагментов кода.Он не будет автоматически генерировать заполнители для каждого параметра, но, тем не менее, он довольно полезен.Вот что вы делаете:

  1. Напишите где-нибудь в вашем коде пример блока комментариев.
  2. Вставьте <#xyz#> туда, где вы хотите, чтобы появился заполнитель с именем 'xyz'.(Это аналог заполнителей параметров, поэтому вы можете переходить между ними и перезаписывать их.)

Например:

/**
 * Method name: <#name#>
 * Description: <#description#>
 * Parameters: <#parameters#>
*/
  1. Открыть правую боковую панель.В нижней панели щелкните значок двух фигурных скобок, чтобы открыть библиотеку фрагментов.
  2. Выберите и перетащите ваш текст в библиотеку фрагментов кода.
  3. Он создаст новый.Дважды щелкните по нему, нажмите «Изменить» во всплывающем окне и дайте ему ярлык для завершения (например, «comblk для блока комментариев»).

Теперь, когда вы вводите «comblk» в любом месте ваших редакторов, всплывающее окно автозаполненияпоявляется, и вы можете нажать кнопку возврата, чтобы вставить в фрагмент.Первый заполнитель будет выбран, и вы можете начать вводить имя метода.Нажмите вкладку, чтобы перейти к описанию и т. Д.

Не идеально, но лучше, чем ничего.Отрывки - хорошая идея, которую Apple еще не закончила реализовывать.

11 голосов
/ 07 марта 2018
  1. Выберите код, для которого вы хотите сгенерировать комментарий, и нажмите Сочетание клавиш

    CMD + ALT + /

  2. Комментарий будет автоматически сгенерирован для выбранного метода.

8 голосов
/ 05 августа 2014

Вы можете использовать этот удивительный плагин.

https://github.com/onevcat/VVDocumenter-Xcode

1 голос
/ 15 марта 2019

Нажмите ⌘ команда + ⌥ опция + / или Editor -> Structure -> Add Documentation

/// <#Description#>
///
/// - Parameter param: <#param description#>
/// - Returns: <#return value description#>
/// - Throws: <#throws value description#>
func fun(param: String) throws -> String? {
    return false;
}

enter image description here

Подробнее Справочник по форматированию разметки

...