Finding Information

查找信息


当你开发app的时候，你会希望在你卡住的时候学到有用的信息。你能在不离开Xcode的情况下得到你需要的所有信息。

Xcode配有一个强大的文档套件，包含许多不同类型的文档，包括通用和概念性的指南、框架和类的参考、以及重点帮助文章。你能通过好几种方式访问这个文档，例如在Xcode区域点击右键来学习如何使用它们，打开在主工程窗口的中的Quick Help面板来感知代码帮助，或者搜索Documentation Window找到所有API的参考。



Use Contextual Help Articles for Xcode Guidance

使用上下文帮助文章得到Xcode指导

当使用Xcode的时候想要获得帮助，可以查看帮助文章。帮助文章显示如何完成常见任务，例如创建一个新类、在IB上设置一个自定义类，以及用自动布局解决问题。

这取决于你想做什么，你能通过按住Control键点击Xcode里的UI元素来访问帮助文章。在上下文菜单中找到最近的条目（在下图里，是工程导航器帮助）。


如果你正在查找一个元素的一般帮助、或者关于任务相关的信息，但它不支持Control-点击，你也能在Xcode Help菜单里搜索上下文帮助索引。



Use Guides for General and Conceptual Overviews

使用指南得到一般概念性概述

学习一项新技术或者深入理解框架里的不同类如何协同工作，需要看一下概念指南。大多数的Cocoa框架和技术有与他们有关的编程指南，例如Sprite Kit Programming Guide, Programming with Objective-C, 和 Location and Maps Programming Guide。

想要在Xcode里查看这些文档，使用文档查看器窗口，你能通过选择 Help > “Documentation and API Reference” (Option–Command–Question Mark)来访问，例如Sprite Kit


结果是按照你编写代码的有用程度排序的。这就意味着你将看到API参考条目列在第一，然后是SDK和工具指南。

如果合适的结果没有出现在弹出列表中，则选择Show All Results 来显示一个你过滤的所有结果。



Use API Reference for Class Information

使用API参考来得到类的信息

当你阅读指南来学习关于技术的不同部分以及你开始使用这些技术来编写代码，你或许查找你需要的内容来了解更多关于这个类能做什么，或者你需要学习调用一个特定类的正确方法。这些信息都在API Reference文档中提供。

举个例子，要想知道关于你在教程较早时候使用的NSString类的更多信息，只需要在文档视图窗口的查找字段里输入类的名字即可。


Top hit通常使你想要的；按下Return来选择，你会看到这个类的API 参考。


API参考文档被定义为让你能够快速访问特定类的信息，包括这个类提供的方法列表，以及信息，例如父类和采用的协议。点击“更多相关项目（More related items）”来看更多关于类的通用信息。


相关项也显示相关指南的列表。举个例子，NSString，你或许想要更多的概念而不是深入研究参考资料，你应该读String Programming Guide

除了描述一个特定方法或属性外，API reference 文档也提供了这个类能执行的所有任务的概述。



Use Quick Help for Contextual Source Code Information

使用快速帮助来得到上下文源代码信息

当你用源编辑器来编写代码的时候，你可以通过Quick Help(choose View > Utilities > Show Quick Help Inspector)面板来轻松访问API reference 文档。快速帮助面板在你编写代码的时候更新，显示的是你当前正在键入的符号的信息。


或者，你可以按住Option在源代码编辑器里点击一个符号来显示一个弹出窗口用来显示快速帮助信息。


从快速帮助面板到弹出窗口，你能在单独的文档检查器窗口打开API Reference，或者你能查看在包含在头文件里的申明文件的yobitticked象征。


Use Sample Code to See Real-World Usage

使用示例代码来看实际使用

除了书面文档外，你也能访问sample code库。每当你在文档检查窗口查看一个快速帮助、或者指南和参考时，你将看到条目显示给定技术或类的相关示例代码。


点击一个示例代码条目来下载并在Xcode中打开一个工程，这样你就能研究代码了。

除了项目中的注释代码为外，一些较大的代码示例也有附件文档。举个例子，Sprite Kit Adventure工程通过code:Explained Adventure伴随一个文档。


iOS Technologies

Where to Go from Here

Copyright 2014 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2013-10-22