块标签(Block Tags)

标签名 别名 描述
@abstract @virtual 这个成员必须在继承类中实现(或重写)。
@access 指定该成员的访问级别(私有 private,公共 public,或保护 protected)
@alias 标记成员有一个别名
@augments @extends 指名这个子类继承至哪个父类,后面需要加父类名
@author 指定项目的作者
@borrows 这个对象使用另一个对象的某些东西
@callback 描述一个回调函数。
@class @constructor 此函数旨在需要使用”new”关键字调用,即构造函数。
@classdesc 使用后面的文字来描述整个类
@constant @const 记录一个对象作为一个常量
@constructs 这个函数成员将成为类的构造函数
@copyright 描述一些版权信息
@default @defaultvalue 记录默认值
@deprecated 说明这已不再是首选方法,即已经弃用
@description @desc 描述一个标识
@enum 描述一个相关属性的集合。
@event 描述一个事件。
@example 提供一个如何使用描述项的例子。
@exports 标识一个由JavaScript模块导出的成员。
@external 标识一个外部的类,命名空间,或模块。
@file @fileoverview 或 @overview 描述一个文件
@fires @emits 描述事件这个方法可能会触发。
@function @func 或 @method 描述一个函数或方法。
@global 记录一个全局对象。
@ignore 忽略文档中的一个标识。
@implements 这个标识实现一个接口。
@inheritdoc 指明这个标识应继承其父类的文档
@inner 描述一个内部对象。
@instance 记录一个实例成员。
@interface 这是别人可以实现的一个接口。
@kind 标识的类型。
@lends 将一个字面量对象的所有属性标记为某个标识符(类或模块)的成员。
@license 标识你的代码采用何种软件许可协议。
@listens 列出一个标识的监听事件。
@member @var 记录一个成员。
@memberof 标明这个标识属于哪个父级标识。
@mixes 此对象混入了另一个对象中的所有成员。
@mixin 记录一个mixin(混入)对象。
@module 记录一个 JavaScript 模块。
@name 记录一个对象的名称。
@namespace 记录一个命名空间对象。
@override 指明一个标识符覆盖其父类同名的标识符。
@param @arg 或 @argument 记录传递给一个函数的参数
@private 标记为私有的。
@property @prop 记录一个对象的属性。
@protected 标记为受保护的。
@public 标记为公开的。
@readonly 标记为只读的。
@requires 这个文件需要一个 JavaScript 模块。
@returns @return 记录一个函数的返回值。
@see 更多详细信息请参阅其他一些文档。
@since 此功能何时被添加进来的?
@static 记录一个静态成员。
@summary 完整描述的一个简写版本。
@this this关键字的指向
@throws 说明可能会被抛出什么样的错误。
@todo 记录一个将要完成的任务。
@tutorial 插入一个链接到包含教程文件。
@type 记录一个对象的类型。
@typedef 记录一个自定义的类型。
@variation 区分具有相同名称的不同的对象。
@version 记录版本信息