Независимо от того, застряли ли вы на сложной ошибке или знакомитесь с каким-то новым кодом, у вас будет доступ к богатому набору документации Xcode, которая продвинет вашу разработку вперед.
В этом уроке вы узнаете, как просматривать различные формы документации, включая библиотеку примеров кода, написанных экспертами Apple.
Что Вы Узнаете
- Как использовать браузер документации
- Как найти примеры кода и руководства по фреймворку
Терминология
Связанные ресурсы
Ссылка на API
Справка по Xcode: Поиск документации разработчика
У каждого разработчика есть предпочтительный способ доступа к документации. Некоторые предпочитают просматривать его в веб-браузере, в то время как другие предпочитают использовать браузер документации, предоставляемый Xcode. Изучив несколько способов взаимодействия с документацией, вы сможете решить, какой метод лучше всего подходит для вас. Чем быстрее вы сможете найти ответы на свои вопросы, тем быстрее сможете вернуться к написанию кода.
Браузер документации
В предыдущем уроке вы добавили строки кода внутри функции viewDidLoad(). Есть ли у вас какие-либо идеи о том, что делает эта функция или когда она вызывается в вашей программе? Xcode предоставляет быстрый ответ с помощью функции быстрой справки. Option-click имя метода viewDidLoad(), и Xcode отобразит всплывающее окно с кратким описанием функции. 1
Во всплывающем окне Quick Help нажмите Open в Developer Documentation, чтобы удобно получить доступ к Developer Documentation Xcode для этой функции. 2 Документация включает в себя более подробное объяснение функции, версии OS, которые ее поддерживают, фреймворк, к которому она принадлежит (в данном случае UIKit), и ссылки на связанные функции.
В навигации слева вы можете быстро перейти к различным разделам документации разработчика. 3 (Вы также можете получить доступ к документации разработчика из меню Window или с помощью сочетания клавиш Command-Shift-0.)
В верхней части окна документации вы увидите поле поиска, которое позволяет вам искать документацию о любой функции, классе или фреймворке. 4 Эта функция позволяет быстро выполнять поиск по тысячам страниц документации, поэтому ответы легко доступны — именно поэтому многие разработчики предпочитают оставлять окно документации открытым во время написания кода.
Попробуйте просмотреть документацию по Xcode. Начните вводить UIViewController. По мере ввода Xcode предложит соответствующие параметры с автозаполнением. Как только вы увидите UIViewController в меню, выберите его, чтобы отобразить документацию для UIViewController.
В правой колонке в разделе "On This Page" щелкните ссылку "Topics", чтобы перейти вниз по странице. В разделе Topics отображается список символов, сгруппированных по темам. Символ - это функция или переменная, связанная с определенным классом. В документации эти символы отсортированы по логическим категориям, а не в алфавитном порядке, чтобы вам было легче находить интересующие вас элементы.
Когда вы создаете новый объект, эти логические категории - отличный способ выяснить, может ли объект делать то, что вам нужно.
Просмотрите разделы для UIViewController и попытайтесь найти символ для свойства view. Щелкните по этому символу.
Здесь вы увидите информацию о выбранном вами свойстве. Большая часть документации по свойствам экземпляра будет следовать аналогичной схеме:
- Краткое описание — Краткое описание того, что представляет собой свойство
- Объявление — имя, используемое для доступа к свойству, и связанный с ним тип свойства
- Обсуждение — Подробное описание, в котором обсуждаются более мелкие (хотя и важные) элементы, которые следует учитывать при использовании свойства
- Смотрите также — Другие символы, связанные со свойством, которые могут представлять интерес
В левом верхнем углу вы увидите две кнопки с шевронами < >. Используйте их для навигации назад < и вперед > по истории просмотров. Нажмите кнопку назад, чтобы вернуться к документации для UIViewController. Найдите символ для функции viewWillAppear(_:).
Большая часть документации по методу будет следовать очень похожему шаблону документации по свойствам экземпляра с одним возможным дополнением:
- Параметры — Если функция имеет параметры (входные данные), они перечислены с именем, используемым для доступа к параметру, и кратким описанием параметра
По мере прохождения этого курса вы будете больше работать с браузером документации.
Примеры кода и темы
В документации разработчика содержится нечто большее, чем просто описания типов и методов. По мере того, как вы будете разбираться в концепциях кодирования, может быть полезно почитать больше об определенной теме или попробовать некоторые примеры кода. Например, top level of documentation for the UIKit framework включает в себя многочисленные обзорные разделы и статьи, которые помогут вам начать работу. А подтема "views and controls" включает в себя пример проекта кода UIKit Catalog.
Вам нужно научиться читать и понимать документацию, чтобы стать успешным разработчиком. Поскольку документация очень техническая, ее может быть трудно переварить при первом чтении. Это требует практики.
На протяжении всего этого курса вам будут предоставлены ссылки на справочные руководства и документацию по API в разделе “Связанные ресурсы”. Прочтите их. Возможно, вы не всегда понимаете каждое предложение или концепцию из прочитанного, но вы приобретете очень полезный навык, который поможет вам стать успешным разработчиком.
Документация для использования в лабораторной работе.
Цель этой лабораторной работы - использовать документацию Xcode для изучения фреймворков iOS. Вы пройдетесь по документации и быстрой справке, чтобы ответить на вопросы о классе UIView и о методе, предоставляемом в проекте Xcode.
Шаг 1
Создайте Документ Pages Для Ваших Ответов
- Создайте новый документ Pages с именем “Документация для использования в лабораторной работе” и сохраните его в папке вашего проекта. Используйте этот документ, чтобы записать свои ответы на вопросы в остальной части этой лабораторной работы. (Если у вас нет приложения Pages, вы можете воспользоваться любым текстовым редактором.)
Шаг 2
Используйте Документацию, чтобы узнать о классе UIView
- Каковы три основных предназначения объекта UIView?
- Как в документации называется представление, встроенное в другое представление?
- Как в документации называется родительский вид, который встраивает другой вид?
- Что такое рамка представления?
- Чем границы представления отличаются от его рамки?
Обязательно сохраните документ Pages в папке проекта.
Отрывок из книги
Develop in Swift Fundamentals
Apple Education
https://books.apple.com/ru/book/develop-in-swift-fundamentals/id1581182804