Справка Quick Help — это лаконичная документация о конкретных темах, обычно об имени символа (класса или метода).

Если на экране открыто окно инспектора Quick Help (<Command+Option+2>), в нем отображается информация о текущем выборе или точке вставки. Например, если вы редактируете код и точка вставки или выделение относятся к слову CGPointMake, то в окне инспектора Quick Help будет отображаться справка о структуре CGPointMake.

Кроме того, справку Quick Help можно получить в окне инспектора Quick Help для объектов интерфейса, выделенных в nib-редакторе, для настроек сборки при редактировании проекта или цели и т.д.

Документация Quick Help может также отображаться во всплывающем окне, а не в окне инспектора Quick Help. Выберите слово и команду Help^Quick Help for Selected Item (<Command+Control+Shift+?>). В качестве альтернативы нажмите клавишу <Option> и установите курсор мыши на выделенное слово, пока он не превратится в знак вопроса (а само слово будет подчеркнуто голубой пунктирной линией), и, удерживая клавишу <Option>, щелкните кнопкой мыши.

Документация Quick Help содержит ссылки. Например, если щелкнуть на ссылке Reference, в справочном окне откроется полная документация; если щелкнуть на ссылке на заголовочный файл, то в окне откроется соответствующий заголовочный файл.

В среде Xcode 5 появилась возможность вставлять документацию о ваших собственных методах в документацию Quick Help. Для этого необходимо написать комментарий в формате doxygen (см. http://www.stack.nl/~dimitri/doxygen/) или HeaderDoc (найдите справку о формате “HeaderDoc” на веб-странице http: / /developer. apple. com). Я рекомендую формат doxygen, который стал фактически стандартом. Перед объявлением или определением метода (или свойства) вставляется комментарий. Например:

/*! Many people would like to dog their cats. So it is \e perfectly

reasonable to supply a convenience method to do so.

\param cats A string containing cats

\return A string containing dogs */

- (NSString*) dogMyCats: (NSString*) cats { return 0"Dogs";

}

Знак восклицания в начале комментария означает, что далее следует комментарий в формате doxygen, а местоположение этого комментария автоматически связывает его с методом dogMyCatsопределение которого следует сразу за комментарием. Выражения с обратной косой чертой, \е, \param и \return, являются командами системы doxygen. В результате, если где-то в коде будет выделен метод dogMyCats:, справка о нем будет отображаться в окне Quick Help (рис. 8.2). Описание метода в формате doxygen (или его краткое описание, которое обозначается командой \brief) также отображается как часть кода (подробнее об этом — в главе 9).

 

Документация о пользовательском методе, вставленная в окно Quick Help 

Pиc. 8.2. Документация о пользовательском методе, вставленная в окно Quick Help


 

 

 

Добавить комментарий