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

Question

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

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

Answer 1

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

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

Например:

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

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

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

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

Answer 2

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

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

Answer 3

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

⌘ + ⌥ + /

где
⌘ = Команда
= альт

Answer 4

1. Выберите код, для которого требуется создать комментарий и нажмите сочетание клавиш

   CMD + ALT +/

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