Skip to content

Commit 96e8126

Browse files
authored
Update README.md
1 parent 9bf5901 commit 96e8126

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,73 @@ Three.js 官方维护人员非常热心和严谨。
110110

111111

112112

113+
<br>
114+
115+
## Three.js官方文档的补充说明
116+
117+
当 Three.js 每次版本迭代更新时,官方只负责维护 英文版 文档,中文版文档完全是靠网友业余时间友情翻译与维护的。
118+
119+
**这就会造成 中文版文档 落后于 英文版文档。**
120+
121+
比如 r130 版本中 `AxesHelper` 新增加了 `.setColors()` 方法,而此时的中文文档中,还未有人相应增加这个方法。
122+
123+
因此当你想要查找某个 类 的用法时,你应该最优先选择去看 **英文** 的官方文档。
124+
125+
> https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene
126+
127+
128+
129+
<br>
130+
131+
我曾经也翻译过好几处地方,提交 PR 也被并入,但是随着时间的推移,逐渐没有翻译的热情了。
132+
133+
因为实在是太多,更新太频繁,没有那么多精力去搞文档。
134+
135+
136+
137+
<br>
138+
139+
## 关于国内有些Three.js示例中代码过时的补充说明
140+
141+
我加了一些 Three.js 交流QQ群,经常有人在里面发一些问题,处在学习阶段的我,经常会去帮忙看一下。
142+
143+
> 看别人遇到的问题,也特别能够提高自己的一些所见所闻,知识面。
144+
145+
经常发生一些这样的情景:**对方说是照着某个示例敲的代码,可就是运行不起来。**
146+
147+
首先我会去官网文档中,查一下他们代码中用到的 类、属性、方法,但是很多时候根本查不到。
148+
149+
这说明他们用的类,属性,方法已发生变更、修改、废弃等。
150+
151+
152+
153+
<br>
154+
155+
此时,我都会到 Three.js github 官方仓库中,在 `Pull requests` 中搜索该属性或方法。
156+
157+
> https://github.com/mrdoob/three.js/pulls
158+
159+
> 搜索时请注意要把 is:open 删除掉,因为既然都被废弃了,那肯定 PR 已经是被并入过的了,状态肯定是 close,不可能是 open。
160+
161+
通常情况下,都可以检索出和废弃的 类、属性、方法相关 PR 信息,点击查看 PR 详情,就能够找到为什么要废弃,建议以后改用 xxx 之类的信息。
162+
163+
至此,原因和结果都知道了,就很容易修复代码了。
164+
165+
166+
167+
<br>
168+
169+
总结一下,想把 Three.js 搞明白,一定要经常做以下 4 件事:
170+
171+
1. 看 英文/中文 文档
172+
2. 去 Github 仓库看源码
173+
3.`Pull requests` 中看最新或之前的 PR 改动
174+
4. 使用、查看源码过程中,发现可以改进的地方,勇敢、大胆得去提交 PR
175+
176+
177+
178+
<br>
179+
113180
## WebGL相关教程
114181

115182
首先说明一下,如果学想对 Three.js 有更深层次的修炼,那么你一定要去学习一下 WebGL。

0 commit comments

Comments
 (0)