常用的jsDoc
2015-11-11 22:50
661 查看
Javascript属于无类型的语言,这对于开发者入门很方便。但对于框架的开发者和IDE的开发者,缺少类型描述有很多不便。其实利用JSDoc稍作扩展,我们可以把它用于类型和值域定义,进而用于代码提示和语法分析。
这样框架的使用者可以在IDE里方便的使用代码提示和语法错误分析功能。下面介绍几个 常用的jsDoc。
这样框架的使用者可以在IDE里方便的使用代码提示和语法错误分析功能。下面介绍几个 常用的jsDoc。
//使用@alias可以给一个变量或者函数指定一个别名,代码提示时会提示该别名 @alias aliasName //使用@constructor可以标识一个函数是构造函数 @constructor //使用@description可以在代码提示时显示被描述变量或者函数的描述信息。 @description 描述内容 //使用@example可以提示代码示例 @example 示例内容 //使用@extends用于标识继承于某个类型 @extends {Type} //使用@param可以描述一个函数的参数以及参数类型,HBuilder扩展了参数值域的写法(目前只支持字符串值域) @param {Type[,Type,...]} ParameterName=[Value1|Value2[|Value3|...]] 参数描述 //使用@property可以描述一个对象的属性 @property {Type[,Type,...]} propertyName 属性描述 //使用@return可以描述一个对象的属性 @return {Type[,Type,...]} //使用@type可以定义某个变量的类型 @type {Type[,Type,...]}
相关文章推荐
- Javascript设计模式理论与实战:桥接模式
- json 解析 读取数据 保存在新的 数组中
- 检查数组的方法
- 新浪微博SDK抛出异常-[__NSDictionaryM weibosdk_WBSDKJSONString]: unrecognized selector sent to instance 0x7fb
- seajs的使用1.0
- 用户填完信息后关闭弹出框并刷新父页面 JS实现
- 浅谈JavaScript中typeof与instanceof的区别
- Angular js 随手记
- js 布尔类型
- json传递死循环问题
- js高级应用
- [读书笔记]高性能JS-编程实践
- js中innerText,innerHTML的用法
- ie6下js更新元素display:block后,仍然不显示的hack办法
- JavaScript事件列表
- 你不知道的JavaScript--Item32 DOM基础详解2
- JSON.parse()和JSON.stringify()
- Perl中调用路径接口(返回值为json)发送邮件
- JavaScript基础——引用类型
- Javascript实现图片的预加载的完整实现