利用 jsdoc 提高自动提示 - Webstorm 入门教程

返回介绍

利用 jsdoc 提高自动提示

发布于 2020-07-06 字数 3434 浏览 1021 评论 0

Webstorm拥有非常强大的自动提示功能,但 javascript 太灵活了,又是弱类型语言,提示的准确度和详细度依然是个问题(比如,一个带参数的函数,Webstorm无法提示出参数的数据类型)。

Webstorm5.0 引入JSdoc的标签支持,通过开发者自己给代码加上符合jsdoc要求的注释,来达到强化js自动提示的目标。

随便写个类,没加任何jsdoc注释时:

  1. function User(name){
  2. this.name= name;
  3. }
  4. User.prototype = {
  5. render:function(){
  6. },
  7. getMoney:function(money){
  8. return money;
  9. }
  10. };

外部调用之:

  1. var minghe = new User('明河');
  2. minghe.getMoney(1000);

在写这二行中,Webstorm给出 User 类和 getMoney 的提示,但如果 getMoney 的参数数据类型只能是数值型,Webstorm 没给出对应的提示。

接下来我们给 getMoney 这个函数加上jsdoc。

(PS:Webstorm非常的知心,当你写好函数时候,输入“/**”加回车,会自动生成 jsdoc 格式的注释)

  1. /**
  2. *
  3. * @param money
  4. * @return {*}
  5. */
  6. getMoney:function(money){
  7. return money;
  8. }

我们补充些限制上去:

  1. /**
  2. *
  3. * @param {Number} money 一个屌丝能有多少钱
  4. * @return {Number}
  5. */
  6. getMoney:function(money){
  7. return money;
  8. }

做个测试:外部传入一个字符串作为参数

利用 jsdoc 提高自动提示

提示你传入的参数不是数值型!!

上面明河只是举了个简单的例子,来看下其他的demo。

先来看下一个带完成jsdoc注释的类,uploader中的queue

利用jsdoc可以强化 Structure 的类成员的索引,有jsdoc补充后,Structure 变得非常方便,我现在我用它来快速定位代码。

使用 ctrl+F12 快速打开 Structure 界面。

利用 jsdoc 提高自动提示

@extends :用于类继承关系的声明

利用 jsdoc 提高自动提示

@typedef:用于复杂数据类型的声明

利用 jsdoc 提高自动提示

上一篇:代码模板

下一篇:JsTestDriver 的使用

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!