iOS开发~优雅的使用Xcode帮助文档及帮助系统

概要

在iOS和OS X开发中，会遇到很多API，类，方法等，而且苹果更新迭代的很快，所以要想最快方式获得第一手资料，那么帮助文档是一个很好的选择。

下载文档

打开Xcode，然后快捷键（command + ,）或Xcode->Preference打开Xcode偏好设置，然后选择Downloads，在Documentation一栏中选择下载你需要的文档：

注意：下载后的文档存放在 ~/Library/Developer/Shared/Documentation/DocSets目录中，其中Library是隐藏文件夹，打开方式是点击前往，然后按住option键，显示出资源库（Library）文件夹，点击进入。

使用文档

打开Xcode，然后快捷键（shift + command + 0）或Help->Documentation And API Reference来打开文档:

可以从头浏览帮助文档，当然也可以使用Search documentation来搜索感兴趣的内容。

帮助系统

当你对某一个类或某方法感兴趣的时候，有两种办法可以快速的了解相关内容：

1.Quick Help for Selected Item 

选中要了解的内容，然后快捷键（shift + control + command + ?）或者按住option按键后单击文本内容，就会弹出快速帮助文档

2、Search Documentation for Selected Text

选中要了解的内容，然后快捷键（control + option + command + /）或者按住option按键双击文本内容，就会在Documentation文档中搜索要了解的内容

注意：我们自己写的代码，如果按要求格式写注释，就可以通过Quick Help for Selected Item查看接口文档，例如：

实际开发中看文档：

关于文档，有一些插件可能在开发中有用：

规范注释生成器VVDocumenter

很多时候，为了快速开发，很多的技术文档都是能省则省，这个时候注释就变得异常重要，再配合Doxygen这种注释自动生成文档的，就完美了。但是每次都要手动输入规范化的注释，着实也麻烦，但有了VVDocumenter，规范化的注释，主需要输入三个斜线“///”，就OK啦！（VVDocumenter在Mac OSX 10.8.5和Xcode 4.6.3上进行开发，应该能支持所有Xcode 4版本，如果想支持Xcode 5，可以对plist文件稍作修改。

项目地址：https://github.com/onevcat/VVDocumenter-Xcode

appledoc - 想自动生成苹果官方那样的文档吗？不用再找了。自动在你的项目中定义超链接符号，使用特殊格式的代码注释来提取内容。生成正式文档和HTML网页。

详情：http://gentlebytes.com/appledoc/

Dash - 一个必须拥有的API文档查看器和代码片段管理器。它很好用，允许你下载并搜索各种语言和框架的API文档，而且速度很快。最快访问文档的方式。为了使搜索更快，我把Dash和Alfred集成起来使用。