Подтвердить что ты не робот

Авто генерировать комментарий метода в Xcode

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

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

Ответ 1

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

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

Например:

/**
 * Method name: <#name#>
 * Description: <#description#>
 * Parameters: <#parameters#>
*/

Откройте правую боковую панель. В нижней панели щелкните на значке двух фигурных скобок, чтобы открыть библиотеку фрагментов.
Выберите и перетащите текст в библиотеку фрагментов кода.
Он создаст новый. Дважды щелкните по нему, нажмите "Редактировать" во всплывающем окне и дайте ему ярлык завершения (например, comblk для блока комментариев).

Теперь, когда вы печатаете "comblk" в любом месте своих редакторов, появляется всплывающее окно автозаполнения, и вы можете нажать "вернуться", чтобы вставить фрагмент. Будет выбран первый заполнитель, и вы можете начать вводить имя метода. Хит вкладка, чтобы перейти к описанию и т.д.

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

Ответ 2

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

⌘ + ⌥ + /

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

Ответ 3

Выберите код, для которого вы хотите сгенерировать комментарий, и нажмите комбинацию клавиш

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

Ответ 4

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

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

Ответ 5

Нажмите ⌘ command + ⌥ option + / или 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;
}

Читать дальше Справочник по форматированию разметки