Я знаю о Doxygen для генерации документации. То, что я ищу, является быстрым способом вставить документацию в XCode, подобный тому, что Eclipse делает при редактировании файлов Java.
Скажем, у меня есть объективный-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 {...
Если у вас хватит терпения, посмотрите здесь , где объясняется поведение завершения и переопределения в XCode. Я не знаю, сработает ли это для набора комментариев, но похоже, что это хорошее начало.
- Фрэнк
В меню "User Scripts" (маленький черный значок прокрутки в строке меню Xcode) есть подменю HeaderDoc с шаблонами для разметки документации в синтаксисе HD. Вы можете установить сочетание клавиш для нужных вам пунктов, зайдя в "Key Bindings" в окне "Preferences" в Xcode.
Поскольку пользовательские сценарии - это, по сути, сценарии оболочки, вы можете использовать любой скриптовый язык для написания своих собственных, так что при желании вы даже можете написать небольшой скрипт с поддержкой regex, который анализирует имена параметров из выбранной строки и заполняет основы вашего комментария в HeaderDoc.