@abstract(同义词:@virtual)
这个成员必须由派生类实现(或覆盖)。
@ access
指定成员的访问级别(private, package-private, public, protected)。
@alias
别名
@async
表明一个函数是异步的。
@augments(同义词:@extends)
表明继承、派生自一个父类。
@author
指明一个项目的作者。
@borrows
这个对象使用另一个对象的一些东西。
@callback
标明一个回调函数。
@class(同义词:@constructor)
指明类
@classdesc
使用以下文本来描述整个类。
@constant(同义词:@const)
文档化一个常数。
@constructs
类构造函数。
@copyright
版权信息。
@default(同义词:@defaultvalue)
文档化默认值。
@deprecated
指示已废弃。
@description(同义词:@desc)
描述。
@enum
文档化枚举。
@event
事件。
@example
提供使用示例。
@exports
指示js导出模块
@external(同义词:@host)
标识一个外部类、名称空间或模块。
@file(同义词:@fileoverview @overview)
描述一个文件。
@fires(同义词:@emits)
描述这种方法内可能触发的事件。 @fires <className>#<eventName>
@function(同义词:@func, @method)
描述一个函数或方法。
@generator
表示一个函数是一个函数生成器。
@global
文档化一个全局对象。
@hideconstructor
表明,构造函数不应该显示出来。
@ignore
不在文档中显示。
@implements
这个符号实现一个接口。
@inheritdoc
表明一个符号应该继承其父的文档。
@in
文档化内部对象。
@instance
文档化实例成员。
@interface
这个符号是别人可以实现一个接口。
@kind
指明符号种类
@lends
文档化对象的属性,就好像他们属于一个给定的名字。
@license
确定适用于这段代码的许可。
@listens
列出这个符号监听的事件列表。
@member(同义词:@var)
文档化一个成员。
@memberof
这个符号属于一个父类符号。
@mixes
这个对象将混合另一个对象的所有成员。
@mixin
文档化混合对象。
@module
文档化JavaScript模块。
@name
文档化对象的名称。
@namespace
文档化命名空间。
@override
表明重载。
@package
这个符号和package-private同义。
@param(同义词:@arg, @argument)
文档化一个函数的参数。
@private
这个符号是私有的。
@property(同义词:@prop)
文档化对象的一个属性。
@protected
这个符号是保护。
@public
这个符号是公开的。
@readonly
这个符号是只读的。
@requires
这个文件需要JavaScript模块。
@returns(同义词:@return)
文档化一个函数的返回值。
@see
参考其他文档的更多信息。
@since
这个功能是什么时候添加的
@static
文档化静态成员。
@summary
较短的版本的完整描述。
@this
这里的“this”指针是指什么
@throws(同义词:@exception)
描述错误。
@todo
待完成任务。
@tutorial
插入一个链接到一个教程文件。
@type
文档化一个对象的类型。
@typedef
文档化自定义类型。
@variation
区分具有相同名称的不同的对象。
@version
文件的版本号。
@yields(同义词:@yield)
文档化函数生成器生成的value
浙公网安备 33010602011771号