Как вы заполняете попсовер Xcode 4 "Option+Click"?

Question

В Xcode 4, если вы нажмете клавишу option + клик по ключевому слову, то упомянутое ключевое слово появится во всплывающем окне с кучей описательной информации, например:

Однако, когда я нажимаю Option + клик по своему собственному методу или переменной, все, что я получаю, это ссылка на файл, в котором был объявлен объект:

Как это сделать? Могу ли я воспользоваться этим для моего собственного кода?

(Я заметил в некоторых заголовках фреймворка, что существует какой-то особый синтаксис комментариев. Может ли это быть связано?)

Answer 1

Вы должны создать свой собственный "набор документации" для вашего API. Поищите в документации Xcode "Руководство по набору документации" и покопайтесь в ней. В разделе "Наборы документации" руководства прямо сказано, что Quick Help использует это.

С установленным документом это всплывающее окно не только найдет описание, но и будет доступно в справке QuickHelp на панели "Утилиты", а также в браузере документации в Организаторе.

Answer 2

Начиная с Xcode 5.0, форматирование Doxygen и HeaderDoc для переменных и методов автоматически анализируется и отображается в всплывающей подсказке Quick Help. Больше информации об этом здесь, но вот несколько ключевых битов:

/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

отображает в Xcode как:

Что касается свойств, это так же просто, как:

/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;

Когда выбран вариант, появляется этот прекрасный поповер: