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

Question

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

Допустим, у меня есть методjective-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 {...

Answer 1

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

РЕДАКТИРОВАТЬ : Вот обновленная версия сценария: https://github.com/premosystems/DoxygenXCodeHelper

Answer 2

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

Answer 3

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

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

Answer 4

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

- Фрэнк