Основным механизмом доступа к документации в среде Xcode является справочное окно (Help1^Documentation and API Reference, <Command+Option+Shift+?>).

В справочном окне выполняется поиск информации; например, нажав клавиши <Command+Option+Shift+?> (или <Command+L>, если вы уже открыли справочное окно), наберите строку NSString и нажмите клавишу <Return>, чтобы выбрать главную подсказку NSString Class Reference. При желании, нажав пиктограмму с изображением увеличительного стекла, можно ограничить вывод информации о комплектах документации.

Существуют два способа просмотра результатов для поиска в справочном окне.

 

Всплывающее окно результатов

Если вы часто набираете строки в поле поиска, в окне результатов будут выводиться около десятка пунктов. Для выбора требуемого результата щелкните кнопкой мыши или воспользуйтесь клавишами навигации и нажмите клавишу <Return>. Если поле поиска находится в фокусе, вплывающее окно результатов можно открывать и сворачивать с помощью клавиши <Esc>.

 

Полное окно результатов

Если поле поиска находится в фокусе и на экране не открыто всплывающее окно результатов, нажмите клавишу <Return>, чтобы открыть окно со всеми результатами поиска. Эти результаты выводятся на четырех отдельных страницах, разделенных по категориям: API Reference, SDK Guides, Tools Guides и Sample Code.

Поиск в справочном окне можно начать, редактируя код. Эта ситуация возникает часто: вы смотрите на символ, который должен использоваться в вашем коде (имя класса, имя метода, имя свойства и т.д.), и хотите узнать о нем больше. Нажмите клавишу <Option> и наведите курсор мыши на слово в вашем коде, пока на экране не появится голубая пунктирная линия подчеркивания; затем (удерживая клавишу <Option>) дважды щелкните на этом слове. На экране откроется справочное окно, и вы получите прямой доступ к этому слову на странице документации об этом классе. Аналогично при выполнении кода (см. главу 9) вы можете щелкнуть на ссылке More и перейти к справке о текущем символе.

В качестве альтернативы можно выбрать текст в своем коде (или где-то еще) и выбрать команду Help^Search Documentation for Selected Text (<Command+Option+Control+/>). Это действие эквивалентно набору текста в поле поиска в справочном окне и просмотру страницы результатов.

Справочное окно работает как веб-браузер, потому что по существу документация состоит из веб-страниц. Действительно, большинство страниц справочника можно найти на сайте разработчиков Apple http: //developer. apple . com. Вы можете открыть в своем веб-браузере страницу, которую в данный момент просматриваете в справочном окне, выбрав команду EditorOShare^Open in Browser или щелкнув на кнопке Share панели окна и выбрав команду Open in Safari. Многочисленные страницы могут одновременно открываться как вкладки в справочном окне. Для этого удерживайте нажатой клавишу <Command> при переходе с вкладки на вкладку — например, нажмите клавишу <Command> и щелкните на ссылке, или нажмите клавишу <Command> и щелкните на пункте во всплывающем окне результатов, или выберите команду Open Link in New Tab в контекстном меню. Пользователь

может переходить с вкладки на вкладку (Window^Select Next Tab), причем каждая вкладка помнит свою историю переходов (выберите команду Navigate^Go Back или щелкните на кнопке Back инструментальной панели окна, которое служит всплывающим меню).

Страницу документации может сопровождать дополнительная таблица содержания или уточнений, или и того и другого. Эти таблицы отображаются на панели Info справа от справочного окна; если она не открыта, ее можно открыть с помощью команды EditorOShow Info или крайней правой кнопки инструментальной панели. Таблицы Table of Contents и Details — это разные панели в окне Info; для того чтобы переключаться между ними, щелкните на одной из пиктограмм на верхнем крае окна Info. Например, страница NSString Class Reference имеет вложенное окно с таблицей содержания, в которой записаны ссылки на все темы в этой странице, а вложенное окно Details ссылается на иерархию наследования класса NSString, его адаптированные протоколы и т.д. Мы еще обсудим этот класс в этой главе. Некоторые страницы документации могут использовать вложенное окно с таблицей содержания, чтобы показать место этой страницы среди более крупной группы страниц. Например, группа String Programming Guide состоит из множества страниц, и когда вы просматриваете одну из них, в окне Table of Contents перечисляются все страницы группы String Programming Guide вместе с главной темой каждой страницы.

Если вы собираетесь вернуться на какую-то страницу документации, сделайте закладку таким образом: выберите команду Editor1^ Share ^Add Bookmark, или щелкните на кнопке Share инструментальной панели и выберите команду Add Bookmark, или (что еще проще) щелкните на пиктограмме закладки на левом поле страницы документации. Закладки отображаются на панели слева от справочного окна; для того чтобы ее открыть, выберите команду EditorOShow Bookmarks или щелкните на второй справа кнопке инструментальной панели. Управление закладками документации простое, но эффективное: закладки можно упорядочивать или удалять, и это все.

Для поиска текста на странице документации используйте команды меню Find. Команда Find О Find (<Command+F>) активизирует панель поиска, как в браузере Safari.

 

В отличие от предыдущих версий среды Xcode, версия Xcode 5 не имеет общей таблицы содержания документации. Это не позволяет пользователю работать с "домашней страницей" комплекта документации, на которой были бы перечислены все комплекты документов. .Однако такая страница все же существует, и ее можно просматривать с помощью браузера. Я рекомендую найти комплект iOS 7 в папке Library/Developer/Shared/Documentation/DocSets, открыть его в окне Finder с помощью контекстного меню Show Package Contents, перейти в файл Contents/Resources/Documents/navigation/index.html, перетащить его в свой браузер и сделать закладку.


 

 

 

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