如何查阅api文档

作者: 工匠前沿 | 来源:发表于2018-01-13 14:33 被阅读0次

今天来谈谈如何查阅文档,应该也适合于其它javascript引擎。

为什么要自己查阅文档?

文档是你应该查阅的第一手资料,从别人教程上读来的某个对象、属性、方法的用法,会让你感觉自己会了,但是没有提到的那些呢?而且不同的教程里讲解也是深浅不一。所以请坚定一个信念,就是官方的文档应该是你的第一手资料。看不懂英文?(●'◡'●),这个已经不是个难题了,之前读到的新闻里说到翻译大赛上有道翻译已经超过了谷歌翻译。你需要的只是一个翻译工具,大把的工具可选,推荐有道翻译。
始终跟着别人的教程走,而没有自己的独立的思考,那么你只是在别人的思想里“翩翩起舞”,这没有什么值得骄傲的。

除了官方文档之外,你还需要阅读什么?

官方一般有Tutorials(引导教程)或是Examples(示例)等等,这两个请优先阅读Tutorials,这个会告诉你怎么使用引擎等等事项。而当你想实现的功能在Tutorials没有提到过,而你又不知道该使用什么对象或它的哪个属性或是方法的时候,不妨看看Examples里面有没有你想要的东西。

那么接下来呢?

读一读基于该引擎的开源的项目。对于Phaser引擎,在首页上列出来很多文章,这里面有教程,也有开源的游戏,不妨看一看它的源码。官方首页文章更新速度是非常快的,你甚至可以用邮箱来订阅官方文档,里面会推荐很多优质的内容。

如何查阅文档呢?

以Phaser官方文档举例,它的地址在这里。

查阅文档.png
箭头指的地方就是这个库里的类。之前的代码里出现过很多次this.load.image('', ''),那么这个代码是什么意思呢?首先它的位置是在一个场景里面,那这个就是一个State对象。通过界面上Classes的下拉或是左侧搜索框里输入State都能找到这个对象。
查阅文档1.png
找到load属性。官方的描述是这样的“这个属性是一个Phaser.Loader对象的索引,你大部分时间在场景的preload方法里调用它来加载外部资源。”
查阅文档2.png
现在点击进去这个Phaser.Loader对象。找到它的image方法。(为什么这里是方法?如果是属性的话,在代码里属性后面跟的是点而不是圆括号。)
查阅文档3.png
这就找到这个方法了,它的描述是添加一张图片到当前的加载队列里。往下可以看到它的参数描述,不过看参数名字就很容易猜出来意思。

同样其它的对象、属性、方法都可以这样来查询,祝大家都能高效地使用这一招技能。

相关文章

  • 如何查阅api文档

    今天来谈谈如何查阅文档,应该也适合于其它javascript引擎。 为什么要自己查阅文档? 文档是你应该查阅的第一...

  • 快速查阅所有常见的API文档

    作为一个程序员会查阅 api 文档是一项必备的技能,下面就来看看如何快速的查阅常用的文档 有一个在线的 API 文...

  • 进阶:Object类

    Object类的如何查看:去源代码中查看去查阅Java的类库的帮助文档。 API:应用程序编程接口整个JDK类库就...

  • 微信小程序的相关总结

    最终要的还是要查阅官方文档 很多基本的东西,各个标签的属性,事件如何使用等,都可以查阅官方文档,其实官方文档是很好...

  • SpringBoot指南|第四篇:集成swagger生成API文

    SpringBoot指南|第四篇:集成swagger生成API文档 本文介绍如何使用swagger生成API文档。...

  • Telegram Client 开发

    可查阅telegram文档安装 到https://my.telegram.org/用手机号登录这个网址申请api申...

  • Dash for Mac(代码文档管理工具) v5.0.2

    Dash for Mac是一款专业的代码文档管理工具,可以让您集中管理API文档,包括离线下载、搜索、查阅,包括各...

  • 代码文档管理工具:Dash for Mac

    Dash for Mac是一款专业的代码文档管理工具,可以让您集中管理API文档,包括离线下载、搜索、查阅,包括各...

  • 如何最便捷查阅PDF文档

    “书签”是阅读必不可少的工具,它方便标记我们的阅读进度。纸质书有书签,电子文档同样有。现在越来越多的文档和书籍是P...

  • 前端图片压缩Canvas

    ?‍?图片压缩Canvas #关于如何实现压缩 查阅MDN找到的是这个API: HTMLCanvasElement...

网友评论

    本文标题:如何查阅api文档

    本文链接:https://www.haomeiwen.com/subject/ykecoxtx.html