Есть ли Javadoc-подобный плагин для Xcode, который автоматически генерирует шаблон doc?

Я знаю Doxygen для создания документации. Я ищу быстрый способ вставить документацию в Xcode, аналогичную тому, что делает Eclipse при редактировании файлов Java.

Скажем, у меня есть метод objective-c с несколькими аргументами вроде этого:

-(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

В Eclipse, если вы поместите курсор над методом и введите: /**<Enter>, вы получите шаблон Javadoc, предварительно заполненный тегами @param и @return.

Можно ли добиться чего-то подобного в Xcode? После ввода /**<Enter>, я хотел бы получить это автоматически:

/**
 *
 * @param one
 * @param two
 * 
 * @return
 */
 -(NSInteger*) sumOf: (NSInteger*) one and:(NSInteger*) two {...

Ответ 1

script здесь http://www.duckrowing.com/2011/05/14/using-the-doxygen-helper-in-xcode-4/ делает именно то, что вы хотите.

ИЗМЕНИТЬ: Ниже приведена обновленная версия Script: https://github.com/premosystems/DoxygenXCodeHelper

Ответ 2

Я успешно использовал VVDocumenter-Xcode в Xcode 5, и он работает хорошо. Он автоматически генерирует шаблон, специфичный для метода, когда вы вводите "///" над методом.

Ответ 3

В меню "Пользовательские скрипты" (этот маленький черный значок прокрутки в строке меню Xcode) есть подменю HeaderDoc с шаблонами для всех видов разметки документации в синтаксисе HD. Вы можете установить комбинацию клавиш для элементов, которые вы хотите использовать, перейдя в "Кнопочные привязки" в окне "Настройки" Xcode.

Поскольку пользовательские скрипты - это, по сути, скрипты оболочки, вы можете использовать любой язык сценариев для написания своих собственных, поэтому, если бы вы хотели, вы могли бы даже написать небольшое регулярное выражение script, которое анализирует имена параметров из выбранной строки и заполняет из основ вашего комментария HeaderDoc.

Ответ 4

Если у вас есть терпение, посмотрите здесь, так как он объясняет поведение завершения и переопределяет в XCode. Я не знаю, будет ли это работать для комментариев, но кажется хорошим началом.

- Фрэнк