Справка 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


Похожие статьи

 

 

 

 
 

Комментарии   

0 #1 Samara 30.10.2019 20:56
I delight in the content on your websites. Thanks
a lot!

Look into my webpage :: Nitro Strength: http://felixpvwp930.yousher.com/an-introduction-to-nitro-strength
Цитировать
0 #2 Gerardo 30.10.2019 22:56
Hi, I want to subscribe for thbis web site tto obtain most up-to-date updates, thus where can i do it please
assist. Buy real Viagra online buy viagra: http://v1agrabuy.com/ Viagra without prescription
Цитировать
0 #3 Marti 02.11.2019 08:15
I think thks is among the most important information for me.
And i am glad reading yor article. But wznna remark on few general things, The
web site style iss perfect, the articls is resally great
: D. Good job, cheers sildenafil citrate tablets 100mg buy viagra: https://www.gener1cv1agra.com
over the counter erection pills
Цитировать
0 #4 Manuel 04.11.2019 17:00
Excellent blog right here! Additionally your website rather
a lot up very fast! What web host aare you using? Can I get your affiliate hyperlink to
your host? I desire my website loaded up aas fast as yours lol chap Viagra buy viagra: http://v1agrabuy.com sildenafil 100mg price walmart
Цитировать
0 #5 Kathrin 06.11.2019 07:48
Thanks for every other great article. Where else may just anyone get
that type of information in such a perfect way of writing?
I've a presentation next week, and I am at the look for such
information.

Here is my web site; inuyasha Cosplay Costumes: http://Social.hyarch.org/index.php/blog/11967/dragon-ball-goku-costume-helps-release-your-cheerful-vigor/
Цитировать
0 #6 Phillipp 07.11.2019 07:20
Hey! I know this is kind of off topic but I was wondering if you knew where
I could get a captcha plugin for my comment form? I'm using the same blog platform as yours
and I'm having trouble finding one? Thanks a lot!


Also visit my web page :: dragon-type pokemon dratini: http://1888bets.com/profile.php?id=1340356
Цитировать
0 #7 Eric 07.11.2019 10:42
Inspiring quest there. What happened after? Thanks!

My web site ... adt
home security: http://gtublog.com/index.php?a=profile&u=ameliechamb
Цитировать
0 #8 Tanya 11.11.2019 15:18
This is my first time pay a visit at here and i am in fact pleassant to read everthing at single place.


Here is my blog ... geek auto com: http://inertialscience.com/xe//?mid=CSrequest&document_srl=4862644
Цитировать
0 #9 Constance 13.11.2019 19:52
High quality WordPress tools:
1. Astra Cloudflare (with Argo); Siteground Supercacher, Dynamic and Memecached;
WP Rocket (minus page cache); some PHP to HTML changes; htaccess tweaks etc.
Цитировать
0 #10 Reagan 15.11.2019 09:39
Hello! Someone in my Myspace group shared this website with us so I came to look it over.
I'm definitely enjoying the information. I'm book-marking and will be tweeting this to my
followers! Great blog and fantastic style and design.

Also visit my web blog; metal prices
business: http://addon.cncal.com/home.php?mod=space&uid=244681&do=profile
Цитировать
0 #11 Deborah 15.11.2019 19:04
Hello, I read your new stuff on a regular basis.
Your humoristic style is witty, keep doing what you're doing!


My website; car part
sites: https://www.cursillo-sac.org/node/52/track
Цитировать

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