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

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

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

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

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

Ответ 1

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

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

Ответ 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;

При нажатии этой кнопки появляется следующее сообщение: