jsdoc笔记

date: 2018.05.25; modification:2018.05.25

目录:

1 常用注释

@augments parent
指明继承自哪个父类

@author 作者名字 <111111111@qq.com>
指明作者

@callback fuc
指明这是一个回调函数,可传递给其他函数

@class
指明需要使用new关键字调用,别名@constructor

@classdesc 类描述
为类添加一大段描述

@constant [ ]
记录一个对象为一个常量

@constructor
指明函数为构造函数

@copyright
指明版权信息

@default []
记录默认值,使用该标签以后会自动添加到文档

@description
提供一般描述,如果在注释开始的地方添加描述,那么可省略该标签

@enum []
描述一个相关属性的集合

@examples
提供一个如何使用描述项的例子

@exports moduleName
标识一个模块

@function name
标记一个对象为一个函数

@global
指明一个全局对象

@instance
记录一个实例成员

@license
标识代码采用何种软件许可协议

@member [] []
记录一个成员

@module
记录一个JavaScript模块

@namespace
记录一个命名空间

@override
指明一个标识符覆盖其父类同名标识符

@param
记录函数参数,别名arg、argument
@param {string} name 描述
存在多种类型
@param {string | string[]} name 描述
重复使用的参数
@param {…number} num
可选参数,默认值
@param {string} [name = 123]

@returns {string} 描述
记录一个函数的返回值,别名return

@static
记录一个静态成员

@this
this关键字的指向

@throws
描述可能会被抛出什么样的错误

@version
描述版本信息

2 参考资料

http://www.css88.com/doc/jsdoc/index.html