如何查阅api文档

今天来谈谈如何查阅文档,应该也适合于其它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

这就找到这个方法了,它的描述是添加一张图片到当前的加载队列里。往下可以看到它的参数描述,不过看参数名字就很容易猜出来意思。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,826评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,968评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,234评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,562评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,611评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,482评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,271评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,166评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,608评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,814评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,926评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,644评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,249评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,866评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,991评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,063评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,871评论 2 354