Как вы заполняете Xover 4 «Option + Click» поповер? - PullRequest
12 голосов
/ 22 апреля 2011

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

enter image description here

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

enter image description here

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

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

Ответы [ 2 ]

10 голосов
/ 22 апреля 2011

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

6 голосов
/ 09 октября 2013

Начиная с 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;

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...