javascript的注解操作,主要应用于大型项目中
单行注释
//
块级注释
/* */
// FIXME: 或 // TODO: 标注需要复查的问题
// FIXME: shouldn't use // TODO: identify versions
@license文件注释 标注文件信息,介绍、版本信息、版权声明、开源协议、修改时间等说明。
/* @license 文件信息 */
文档注释 描述与指定所有参数和返回值的类型和值的注释标签
/** 文档信息 */
常用注释标签@param 指定参数的名称。
//可以包含参数的数据类型,使用大括号括起来,和参数的描述 @param {string} a 是个数字类型的参数
@returns 属性
//如果有返回值增加@returns 如果没有省略此属性 //参数和返回值类型Type:string、boolean、number、object、array、function @returns{string} b 是个字符串
标签 | 描述 |
@module | 当前文件模块,文件中的所有成员将被默认为属于此模块,除另外标明 |
@submodule | 针对模块的划分,处于@module |
@class | 标示一个类或者一个函数 |
@constructor | 对象字面量形式定义类时,可使用此标签标明其构造函数 |
@callback | 标明是一个回调函数 |
@event | 标明一个可触发的事件函数,一个典型的事件是由对象定义的一组属性 |
@constant | 常量 |
@member/@var | 一个基本数据类型的成员变量 |
@method | 方法或函数 |
@param | 方法参数及参数类型 |
@property | 一个对象的属性 |
@readonly | 只供阅读 |
@return | 返回值、类型及描述 |
@type | 代码变量的类型 |
@description | 在注释开始描述可省略此标签 |
@enum | 一个类中属性的类型相同时,使用此标签标明 |
@example | 示例,代码可自动高亮 |
@exports | 标识此对象将会被导出到外部调用 |
@ignore | 忽略此注释块 |
@link | 内联标签,创建一个链接 |
@name | 指定一段代码的名称,强制使用此名称,而不是代码里的名称 |
@namespace | 指定一个变量为命名空间变量 |
@static | 描述一个不需实例即可使用的变量 |
@summary | 描述信息的短叙述 |
@throws | 方法将会出现的错误和异常 |
@todo | 函数的功能或任务 |
@tutorial | 一个指向向导教程的链接 |