iOS官方文档阅读

计划认真学习下官方文档 在此做下记录 方便查阅

找到文档


先打开Xcode然后快捷键command+shift+0
如果快捷键出来的是搜索框 那是因为这个快捷键重复了 点击工具栏window 下的documentation and API Reference


iOS官方文档阅读_第1张图片
一共就三个

打开iOS8.3 其它两个先不管

iOS官方文档阅读_第2张图片
iOS8.3 所包含内容

文档下的资料分类


Audio & Video

此目录主要介绍音视频

Cocoa Touch Layer
Core OS Layer 系统中心层

里面包含了CoreBluetooth框架的所有内容

Core Services Layer
Data Management —— 数据管理。
General

此文档下难得有个中文文档 《马上着手开发iOS应用程序》是一个初学者最好不要错过的东西

Graphics & Animation —— 图形和动画
Languages & Utilities —— 语言和工具,Objective-C的一些知识,App Store的管理工具等。
Mathematical Computation —— 数学计算。
Media Layer
Networking & Internet —— 网络问题。
Performance —— 性能。
Security —— 安全。
User Experience —— 用户体验。
Xcode

资料的划分规则


iOS官方文档阅读_第3张图片
一般点开分为三部分
Sample Code —— 示例代码

苹果官方提供的一些示例代码,帮助你学习某些技术某些API。非常强烈建议学习的时候参考,一方面光看文档有时候还是很难弄明白具体实现是怎么回事儿。另外一方面这些示例代码都是苹果的工程师写的,你从示例代码的变迁可以看到苹果官方推荐的代码风格流变。

Guides —— 指南

指南是Xcode里面最酷最好的部分,学会看指南则大多数情况完全不用买书。Xcode文档里面的指南,就是一个一个问题的,从一个问题,或者系统的一个方面出发,一步一步详细介绍怎么使用Cocoa库的文档。一般程序员比较熟悉的是Reference,就是你查某个类、方法、函数的文档时候,冒出来的东西。那些其实是一点一点的细碎知识,光看那些东西就完全没有脉络。而Guides就是帮你整理好的学习的脉络。

Reference —— 参考资料

一个一个框架一个一个类组织起来的文档,包含了每个方法的使用方法。

文档阅读的一些补充


帮助文档中的一些关键词作用

NS_AVAILABLE 表示可用
- (void)peripheralDidUpdateName:(CBPeripheral *)peripheral NS_AVAILABLE(NA, 6_0);
例如上面这句就是表示 该方法在6.0系统后可用 如果你是5.0肯定用不了的 或者直接崩溃.

NS_DEPRECATED 表示弃用
@property(readonly) BOOL isConnected NS_DEPRECATED(NA, NA, 5_0, 7_0);
例如这句表示5.0引用 7.0就废弃了 NA 表示缺省 参数无效不用填

__OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0,__MAC_10_5,__IPHONE_NA,__IPHONE_NA)
os x 10.0 开始引进这个方法 10.5之后废弃了,ios上从来没只支持过。

- (id)objectAtIndexedSubscript:(NSUInteger)idx NS_AVAILABLE(10_8, 6_0);
如果是OSX和iOS通用的方法 会填满 支持单个系统的方法 就会出现缺省
比如上面这句是通用的Foundation框架的方法 就没有NA

NS_DESIGNATED_INITIALIZER
CB_EXTERN_CLASS

从代码中查看文档

按住Option键,然后点击你想查询的关键词,就会获得关键词的帮助信息。


iOS官方文档阅读_第4张图片
代码中查看

Declaration 声明
Description 描述
parameters 参数
returns 返回值
Inherits from 继承关系,继承自
Conforms to 遵循什么协议
Framework 属于什么框架
Availability 从什么iOS版本开始支持
Declared in 头文件
Sample Code 相关例子代码
Guide 相关的指南

查看官网文档

参考:苹果Xcode帮助文档阅读指南

你可能感兴趣的:(iOS官方文档阅读)