对于我们的程序员来说,无时无刻都在与各种文档进行亲密接触,有编程语言的帮助手册文档、有第三方接口文档、有第三方库文档等等,总而言之,文档对于我们程序员来说非常非常的重要,那么下面我们就分享一些看各种编程文档的诀窍,希望能够帮助到你。
编程语言的帮助手册文档
对于大部分的编程帮助手册文档,一般的文档结构大致都是该编程语言的大体介绍、一个简单的DEMO、开发环境搭建、编程语言的语法结构、各种函数方法列表、其他部分,下面是一个参考的学习列表:
开发环境搭建
语法结构
一个简单的DEMO
各种函数和方法的长期实践
开发环境让我们有地方写代码、语法结构让我们知道怎么写、DEMO让我们开启这个语言的大门、长期的实践各种函数和方法,让我们不再重复造很多轮子。
第三方接口文档
这里说的第三方接口是一些外部第三方,比如阿里云产品的API、某短信公司提供的API、微信公众号的API等等,这类接口文档,一般的结构是:请求URL和公共参数的说明、签名的说明、各种接口的说明、其他,下面是一个参考的学习列表:
学会怎么签名
从接口列表里面选择一个你认为简单的并将其实现
其他接口的实践
这里说明一点的是,这类接口里面签名是一个难点,需要明白一些专业术语,比如URL编码、字典顺序、哈希算法等等。
其实,如果大家学过SEO优化的话,都知道页面的显示权重是从上到下,从左到右,就是重要的内容从上面左边开始,然后到右边,一直到页面的右下角,同样各种编程文档也是一样,一些重要的文档知识一般都在文档的前面,只有看懂了这些文档知识,才能够看懂后面的文档,切记不要到处乱看,除非你已经很熟悉了,否则对于你来说,很容易犯迷糊。