程序员在编码开发的过程中,为了减少重复造轮子,总免不了要学习和使用开源库。为此,从对应库的官方网站阅读文档是一个强烈建议养成的好习惯
先说说为什么不建议直接去 baidu 里找资料
国内很多平台都可以写技术博客,比如 CSDN,简书,掘金等,当我们想了解某个库的使用方法时通常 baidu 出来的都是这几个平台里的内容,但是存在以下问题
- 写的人太多,不知道谁写得更准确
- 有的标题党专门把人骗进去,实际挂了一个转载链接
- 写得没有头绪,排版很乱,可读性差
- 内容过时,不符合当前最新的版本
为了避免上述问题,建议我们从官网去寻找答案
首先,由于官方的文档是第一手资料,无论从准确性还是更新程度都是最好的
其次,热门的开源库或者框架官网做得也非常棒,无论是描述使用方法,还是示例代码,都简洁明了,可读性非常高
不过大多数国外的开源库对应的官网都是英文的,给一些程序员带来困扰。实际上不必担心,如果暂时英文不够熟练,google 翻译全文就解决了
那么,面对官网的内容,如何快速获取信息呢?毕竟我们日常开发工作紧,没有时间慢慢去细品官网的内容(当然如果要吃透某个库,官方文档是强烈推荐要认真去看的)
首先从 github 上找到这个库,比如消息中间件框架 rockedMQ

通常在其 github 的 README.md 里面都会提供官网的 URL

然后,在首页中寻找 Getting Started,这是快速了解该库或者框架的核心
比如 rocketMQ 的这一项就在很醒目的位置

在 Getting Started 页里描述的内容,通常都能让我们立即明白它的用法,并且完成一个小 demo。例如从 rocketMQ 的快速入门里,我们能了解到该框架的依赖项,如何启动服务,关闭服务以及收发消息
再比如 Android 的 EventBus 库的官网页面,getting started 在底部的位置

这里面介绍了如何定义 events,如何 subscribe event 以及如何 post event,并提供了示例代码
第三,想掌握更多的用法,就需要进入 document page 中寻找答案
比如

完整的描述中,分类也非常清楚,容易找到自己关心的内容
第四,寻找示例代码
查看官网资料的过程中,结合代码能更快熟悉其用法
在 rocketMQ 的 document page 中直接有 sample code

在 Android Espresso 的 page 中提供了 sample code 的 github 链接

总结一下,学会看官方文档,就是寻找官网 URL,查看 getting started,查看 full document,阅读 sample code