JavaScript的@param注解
@property name{String}交互类型
@property params{Object}附带参数
@property func{Function}回调函数
param name
/**
* 获取事件在列表中的位置
* @param context
* @param callback
* @private
*/
_evIndex(event, context, callback){
let index =-1;
for(let i =0; i <= event.length; i++){
if(event[i].context === contex && event[i].callback === callback){
index = i;
break;
}
}
return index;
}
/**
* 绑定事件
* @param eventType string 事件类型
* @param context Object callback的this作⽤域
* @param callback
*/
on(context, eventType, callback){
if(typeof eventType !='string'||typeof callback !='function'){
return;
}
let event =this.store[eventType];
let eventObj ={
context: context,
callback: callback
};
if(!event ||!Array.isArray(event)){
this.store[eventType]=[eventObj];
}else if(this._evIndex(event, context, callback)<0){
this.store[eventType].push(eventObj);
}
}
@module
标明当前⽂件模块，在这个⽂件中的所有成员将被默认为属于此模块，除⾮另外标明@submodule
针对模块的划分，处于@module之下
@class
标⽰⼀个类或者⼀个函数
@constructor
当使⽤对象字⾯量形式定义类时，可使⽤此标签标明其构造函数
@callback
标明此⽅法是⼀个回调函数
@event
标明⼀个可触发的事件函数，⼀个典型的事件是由对象定义的⼀组属性来表⽰。
@constant
常量标识
@member/@var
记录⼀个基本数据类型的成员变量
@method
标记⼀个⽅法或函数
@param
标记⽅法参数及参数类型
@property
标明⼀个对象的属性
@readonly
只读
@return
标明返回值、类型及描述
@type
描述代码变量的类型
@description
如果在注释开始描述可省略此标签
@enum
⼀个类中属性的类型相同时，使⽤此标签标明
@example
⽰例，代码可⾃动⾼亮
@exports
标识此对象将会被导出到外部调⽤
@ignore
忽略此注释块
@link
内联标签，创建⼀个链接，如`{@link github Github}`
@name
指定⼀段代码的名称，强制 JSDoc 使⽤此名称，⽽不是代码⾥的名称@namespace
指定⼀个变量为命名空间变量
@static
描述⼀个不需实例即可使⽤的变量
@summary
对描述信息的短的概述
@throws
描述⽅法将会出现的错误和异常
@todo
描述函数的功能或任务
@tutorial
插⼊⼀个指向向导教程的链接
* @param {Object} state vuex state
* @param {Boolean} collapse is collapse

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。