text
stringlengths
0
13.4k
documentation in a number of ways, such as right-clicking on areas of Xcode to learn how to use them, opening
the Quick Help pane in the main project window for context-aware code help, or searching in the Documentation
Window to find guides and full API reference.
Use Contextual Help Articles for Xcode Guidance
To get help when using Xcode itself, take a look at help articles. Help articles show how to accomplish common
tasks, such as creating a new class, setting a custom class in Interface Builder, and resolving issues with Auto
Layout.
2013-10-22 | Copyright © 2013 Apple Inc. All Rights Reserved.
116
Finding Information
Use Contextual Help Articles for Xcode Guidance
Depending on what you’re trying to do, you can access some help articles by Control-clicking on a UI element
in Xcode. Look for the last entry (in this image, Project Navigator Help) in the contextual menu.
If you’re looking for general help, or information about a task related to an element that doesn’t support
Control-clicking, you can also search for contextual help in the Xcode Help menu.
2013-10-22 | Copyright © 2013 Apple Inc. All Rights Reserved.
117
Finding Information
Use Guides for General and Conceptual Overviews
Use Guides for General and Conceptual Overviews
To learn about a new technology or to gain a deeper understanding of how the different classes in a framework
work together, look at one of the conceptual guides. Most Cocoa frameworks and technologies have
programming guides associated with them, such as Sprite Kit Programming Guide , Programming with Objective-C ,
and Location and Maps Programming Guide .
To view these documents in Xcode, use the documentation viewer window, which you can access by choosing
Help > “Documentation and API Reference” (Option–Command–Question Mark). Simply type the name of a
technology, such as Sprite Kit.
The results are ordered to be most helpful when you are writing code. This means that you’ll see API reference
entries listed first, and then SDK and Tools guides.
2013-10-22 | Copyright © 2013 Apple Inc. All Rights Reserved.
118
Finding Information
Use API Reference for Class Information
If a suitable result doesn’t appear in the pop-up list, choose Show All Results to display a complete set of results
that you can filter.
Use API Reference for Class Information
When you’ve read a guide to learn about the different parts of a technology and you start writing code that
uses the technology, you’ll probably find that you need to know more about what an individual class can do,
or that you need to learn the correct way to call a particular method. This information is provided by API
reference documents.
2013-10-22 | Copyright © 2013 Apple Inc. All Rights Reserved.
119
Finding Information
Use API Reference for Class Information
For example, for more information on the NSString class that you used in the earlier tutorials, just type the
name of the class in the documentation viewer window’s search field.
2013-10-22 | Copyright © 2013 Apple Inc. All Rights Reserved.
120
Finding Information
Use API Reference for Class Information
The top hit is usually the one you want; press Return to select it, and you see the API reference for that class.
2013-10-22 | Copyright © 2013 Apple Inc. All Rights Reserved.
121
Finding Information
Use API Reference for Class Information
API reference documentation is designed to give you quick access to information about individual classes,
including the list of methods the class provides, and information such as the parent class and adopted protocols.
Click “More related items” to see to see general information about the class.
The Related Items popover also shows a list of related guides. For NSString, for example, you might want a
more conceptual overview rather than delving into reference material, so you should read String Programming
Guide .
2013-10-22 | Copyright © 2013 Apple Inc. All Rights Reserved.
122
Finding Information
Use API Reference for Class Information
In addition to describing a specific method or property, API reference documents also provide an overview of