1.4　如何使用API帮助

1.4　如何使用API帮助

对于初学者来说，学会在Xcode中使用API帮助文档是非常重要的。下面我们通过一个例子来介绍API帮助文档的用法。

在编写HelloWorld程序时，可以看到ViewController.swift的代码，具体如下所示：

import UIKit
class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view, typically from a nib.
    }
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }
}

如果我们对于didReceiveMemoryWarning方法感到困惑，就可以查找帮助文档。如果只是简单查看帮助信息，可以选中该方法，然后选择右边的快捷帮助检查器 {%} ，如图1-16所示。

{%}

图 1-16　Xcode快捷帮助检查器

在打开的Xcode快捷帮助检查器窗口中，可以看到该方法的描述，其中包括使用的iOS版本、相关主题以及一些相关示例。这里需要说明的是，如果需要查看官方的示例，直接从这里下载即可。

如果想查询比较完整的、全面的帮助文档，可以按住Alt键双击didReceiveMemoryWarning方法名，这样就会打开一个Xcode API帮助搜索结果窗口，如图1-17所示。然后选择感兴趣的主题，进入API帮助界面，如图1-18所示。

{%}

图 1-17　Xcode API帮助搜索结果窗口

{%}

图 1-18　Xcode API帮助界面

API帮助文档还提供给我们一些官方示例，在左边的导航面板中可以找到相关的Sample Code，如图1-19所示。单击展开“Sample Code”找到相关示例工程并单击，在右边内容窗口中可以看到关于该示例的描述，如果单击“Open Project”按钮，就可以打开并下载这个示例工程。

{%}

图 1-19　官方案例

1.4 如何使用API帮助