【技术晨读】技术的正宗与野路子( 二 )


用Java语言编程的时候,我们需要不断查阅的就是这份API。我们平常一般是通过IDE来快速查看某个接口的文档说明 。
开发
针对新手的类型的资料,官网上称为:
这份资料是典型的 。它教你制作第一个 App,并针对若干个主题进行一步一步的教学 。
下面这份资料在官网上被称为:API。
它实际上是一份介于和Spec之间的文档 。它有很多Spec的特点,比如它介绍中的抽象的四大组件的概念,介绍资源尺寸的抽象(dp),介绍View层原理,等等 。但是,跟前面看到的Java Spec相比,它没有那么规范和正式,描述也更随意一些,估计也算不上完备(但涉及到了技术的绝大部分) 。
当我们对中某项具体技术存疑,或是有争论的时候,我们就需要来翻翻这份文档 。因此,它基本可以归入Spec类型 。
然后是 SDK的API :
【【技术晨读】技术的正宗与野路子】这份API 的质量并不高,描述上过于简略,甚至模糊不清,其可读性跟前面提到的JDK 8的API 完全不在一个水平上 。这也是一些开源项目的通病,不重视接口文档 。
iOS开发
苹果在iOS开发方面给出的文档是相当丰富的,这也是一个闭源系统做得好的地方 。
iOS开发的文档,很难区分出和Spec这两个层面 。它由很多文档组成,每个文档描述系统的某一方面 。通常是在一个文档中,既有教学的部分,又有完备描述的部分 。
针对完全的新手入门的话,下面这个文档,算是真正的一个:
其它各个文档也是介于和Spec之间,更偏向Spec 。比如:
然后是iOS的API :
如前所述,这份API 的可读性非常高,比 SDK的要强多了 。很多前后相关的概念,在这份API 的描述中,都有体现 。
当然,除了之外,iOS的文档也都可以通过XCode取到 。
Redis
Redis的是我见过的最好的,它对初学者非常友好,不仅能读,还能执行 。
Redis的Spec举例:
Redis的 :