cesium编程中级(九)Cesium工具篇-VS Code提示

cesium工具篇-VS Code提示

使用:

cd project
npm install --save @types/cesium
  1. 最好重启一次Vscode
  2. 在项目文件夹中多了 project\node_modules\@types\cesium,
  3. 然后在项目中新建js文件,发现可以成功提示

注意:只在js文件中才有提示,html文件中没有

以下是对这个解决方案的一些记录和思考,不喜勿看

起因

Cesium中的函数有些比较长,很多时候写的话都需要一边查文档,一边复制粘贴,觉得很麻烦。

工具

  • 以前使用Sublime,曾经根据它的规则,使用nodejs引入cesium模块,通过遍历Cesium对象生成过一个提示文件,项目名称sublime-cesium,但是没有好好完善,由于工作内容变更,这个也没再继续下去
  • 后来开始使用了 VScode,同样面临这个问题,上网搜了很多却发现没有现成的解决方案,于是又想着研究一下这个编辑器的提示机制,生成一个提示文件出来,通过参考网上的资料,找到一种使用Typings的方式来实现(typings可自行百度谷歌),提示描述的来源可以有以下三种方式:
    1. 和原来一样,使用nodejs引入cesium模块,通过遍历Cesium对象(不难,问题在于生成的文件中,参数没有相关描述)
    2. 同样使用nodejs,通过读取Cesium包中的Documentation文件夹下的网页,爬取需要的信息,然后生成目标 index.d.ts文件(不难,但是想想觉得很麻烦)
    3. 通过研究jsdoc等相关资料,看看jsdoc是怎么通过Cesium源码生成API文档的,然后根据这个去生成目标 index.d.ts(感觉有点难,对于jsdoc不确定)

    最终选定了第二个方案,然后吭哧吭哧写代码,成果项目名称cesiumvsc,到这里基本上完成了0.01版本,虽然有很多问题,但是可以正常使用了(这里给自己的总结就是,思路走通了,就赶紧动手去做吧,做可能遇到很多问题,不做就永远只能止步不前)。

  • 最后想着要是能在vsc的扩展商店里面发布一下,那就可以吹一波了,于是又搜了一下有没有js库在里面发布的,同时想到了比较有名的Threejs,商店里没有,但是搜到一句代码
    npm install --save @types/three
    

    通过 npm @types 找到DefinitelyTyped https://github.com/DefinitelyTyped/DefinitelyTyped,重点来了,我进入types 文件夹里面一看,原来已经有了Cesium,开心~

总结

  1. 思路走通了,就赶紧动手去做吧,做可能遇到很多问题,不做就永远只能止步不前
  2. 花在事情上的时间总会有搜获,这个过程,我用了typings,nodejs,cheerio…接触新的东西总会带来不同的感受
  3. 一定程度提升解决问题的能力
  4. 最后基本解决了问题,可能我的项目会有0.02版本,谁知道呢 ^_^

参考:

2 thoughts to “cesium编程中级(九)Cesium工具篇-VS Code提示”

  1. 我引入了@types/cesium没能正确看到提示,我用得办法是,在js头部加上 require(‘cesium’)。即可看到Cesium的proto和实例方法等。

发表评论

电子邮件地址不会被公开。 必填项已用*标注