📄️ @abstract
@virtual
📄️ @access
@access 指定该成员的访问级别(包 package,私有 private,公共 public,或保护 protected)。你可以使用与 @access 标签同义的其他标签:
📄️ @alias
@alias 标签标记成员有一个别名。如果该成员有不同的名称,JSDoc 把所有引用作为这个成员。如果你在一个内部函数中定义一个类的时候,这个标签是非常有用的;在这种情况下,您可以使用 @alias 标签告诉 JSDoc,这个类如何在您的应用程序中暴露出来。
📄️ @async
@async 标记表示函数是异步的,这意味着它是使用语法 async function foo () {} 声明的。不要将此标记用于其他类型的异步函数,例如提供回调的函数。JSDoc 3.5.0 及更高版本中提供了此标记。
📄️ @augments
@augments 或 @extends 标签指明标识符继承自哪个父类,后面需要加父类名。你可以使用这个标签来记录基于类和并基于原型的继承。
📄️ @author
@author 标签标识一个项目的作者。在 JSDoc3.2 和更高版本中,如果作者的名字后面跟着尖括号括起来的电子邮件地址, 默认模板将电子邮件地址转换为 mailto: 链接。
📄️ @borrows
@borrows 标签允许将另一个标识符的描述添加到当前描述。
📄️ @callback
@Callback 标签提供回调函数(可传递给其他函数)的描述,包括回调的参数和返回值。可以包涵任何一个能提供给 @method标签。
📄️ @class
@class 标记将函数标记为构造函数,这意味着要使用 new 关键字调用它以返回实例。
📄️ @classdesc
@classdesc 标签用于为类提供一个描述,这样和构造函数的描述区分开来。@classdesc标签应该与 @class (或 @constructor)标签
📄️ @constant
@constant 标记用于将文档标记为属于常量的符号。
📄️ @constructs
当使用对象字面量形式定义类(例如使用 @lends 标签)时,可使用 @constructs 标签标明这个函数用来作为类的构造实例。
📄️ @copyright
@copyright 标签是用来描述一个文件的版权信息。一般和 @file 标签结合使用。
📄️ @default
@default 标签记录标识的赋值。可以在标签后面跟上他的值,或者当值是一个唯一被分配的简单值(可以是:一个字符串,数字,布尔值或null)的时候,可以让JSDoc从源代码中获取值,自动记录。
📄️ @deprecated
@deprecated 标签指明一个标识在代码中已经被弃用。
📄️ @description
@description 标记允许提供正在记录一般说明。描述可以包括 HTML 标记。如果启用了 Markdown 插件,它也可包括 Markdown 格式。
📄️ @enum
@enum 标记记录了一组静态属性,这些属性的值都属于同一类型。
📄️ @event
@event 标记可以触发的事件。典型事件由一个具有一组已定义属性的对象表示。
📄️ @example
提供如何使用文档化项的示例。此标记后面的文本将显示为突出显示的代码。
📄️ @exports
在 JSDoc3.3.0 或更高版本中,<moduleName> 可以包含 module: 前缀。在以前的版本中,必须忽略此前缀。
📄️ @external
@external 标记标识在当前包外部定义的类、命名空间或模块。通过使用此标记,可以将包的扩展记录到外部符号,也可以向包的用户提供有关外部符号的信息。还可以在任何其他 JSDoc 标记中引用外部符号的 namepath。
📄️ @file
@file 标签提供文件的说明。在文件开头的 JSDoc 注释部分使用该标签。
📄️ @fires
@fires 标记表示方法在调用时可以触发指定类型的事件。使用 @event标记来记录事件的内容。
📄️ @function
将一个对象标记为一个函数,即使在解析器看来它可能不是一个函数。它将 doclet 的 @kind 设置为 function。
📄️ @generator
@generator 标记表示函数是一个生成器函数,这意味着它是使用语法函数 *foo () {} 声明的。JSDoc 3.5.0 及更高版本中提供了此标记。
📄️ @global
@global 标记指定一个符号应作为全局符号出现在文档中。JSDoc 忽略源文件中符号的实际作用域。此标记对于在本地定义然后指定给全局符号的符号特别有用。
📄️ @hideconstructor
@hideconstructor 标记告诉 JSDoc 生成的文档不应该显示类的构造函数。JSDoc 3.5.0 及更高版本中提供了此标记。
📄️ @ignore
@ignore 标签表示在代码中的注释不应该出现在文档中,注释会被直接忽略。这个标签优先于所有其他标签。
📄️ @implements
@implements 标签表示一个标识实现一个接口。
📄️ @inheritdoc
@inheritdoc 标记表示应该从其父类继承其文档。JSDoc 注释中包含的任何其他标记都将被忽略。
📄️ @inner
使用 @inner 标记会将符号标记为其父符号的内部成员。这意味着它可以被 “Parent~Child” 引用。
📄️ @instance
使用 @instance 标记会将符号标记为其父符号的实例成员。这意味着它可以被称为 Parent#Child。
📄️ @interface
用作 JSDoc 标签字典 (默认开启):
📄️ @kind
<kindName> 取值为:
📄️ @lends
@lends 标签允许将一个字面量对象的所有成员标记为某个标识符的成员,就像他们是给定名称的标识符成员。如果要将对象文字传递给从其成员创建命名类的函数,则可能需要执行此操作。
📄️ @license
@license 标记标识应用于代码任何部分的软件许可证。
📄️ @listens
@listens 标记指示符号侦听指定的事件。使用 @event标记来记录事件的内容。
📄️ @member
@member 标记标识没有特殊类型的任意成员,例如“类”、“函数”或“常量”。成员可以选择具有类型和名称。
📄️ @memberof
@memberof 标签标明成员隶属于哪一个父级标识符。
📄️ @mixes
@mixes 标签指示当前对象混入了 OtherObjectPath 对象的所有成员,被混入的对象就是一个 @mixin。
📄️ @mixin
@mixin 标签提供旨在被添加到其他对象的功能。然后,可以将 @mixes 标签添加到使用了该 mixin(混入)的对象上。
📄️ @module
在 JSDoc3.3.0 或更高版本中,<moduleName> 可能包括 module: 前缀。在以前的版本中,必须忽略此前缀。
📄️ @name
@name 标签强制 JSDoc 使用这个给定的名称,而忽略实际代码里的名称。这个标签最好用于虚拟注释,而不是在代码中随时可见的标签,如在运行时期间产生的方法。
📄️ @namespace
@namespace 标记表示对象为其成员创建命名空间。您还可以编写一个虚拟 JSDoc 注释来定义代码使用的命名空间。
📄️ @override
@override 标签指明一个标识符覆盖其父类同名的标识符。
📄️ @package
使用 JSDoc 标记字典(默认情况下启用):
📄️ @param
@param 标记提供函数参数的名称、类型和描述。
📄️ @private
使用 JSDoc 标记字典(默认情况下启用):
📄️ @property
@property 标记是一种方便地记录类、命名空间或其他对象的静态属性列表的方法。
📄️ @protected
使用 JSDoc 标记字典(默认情况下启用):
📄️ @public
@public 标签标记标识符为公开的。
📄️ @readonly
标记一个标识符为只读。JSDoc 不会检查某个代码是否真是只读的,只要标上 @readonly,在文档中就体现为只读的。
📄️ @requires
@requires 标签可以记录一个模块需要的依赖项。一个 JSDoc 注释块可以有多个 @require 标签。模块名可以被指定为 moduleName 或者 module:moduleName;这两种形式将被解析为模块。
📄️ @returns
@returns 标记记录函数返回的值。
📄️ @see
@see 标签表示可以参考另一个标识符的说明文档,或者一个外部资源。您可以提供一个标识符的 namepath 或自由格式的文本。如果你提供了一个 namepath,JSDoc 的默认模板会自动将 namepath 转换成链接。
📄️ @since
@since 标记表示在特定版本中添加了类、方法或其他符号。
📄️ @static
@static 标记表示符号包含在父项中,可以在不实例化父项的情况下访问。
📄️ @summary
@summary 标签是完整描述的一个简写版本。它可以被添加到任何的 doclet。
📄️ @this
@this 标签指明 this 关键字的指向。
📄️ @throws
@throws 标记记录函数可能引发的错误。可以在一个 JSDoc 注释中多次包含 @throws 标记。
📄️ @todo
@todo 标签记录要完成的任务。在一个 JSDoc 注释块中您可以包含多个 @todo 标签。
📄️ @tutorial
@tutorial 标签插入一个指向向导教程的链接,作为文档的一部分。有关创建教程指导请参阅 tutorials overview。
📄️ @type
@type 标记允许您提供一个类型表达式,用于标识符号可能包含的值类型或函数返回的值类型。您还可以将类型表达式包含在许多其他 JSDoc 标记中,比如 @param 标记。
📄️ @typedef
@typedef 标签在描述自定义类型时是很有用的,特别是如果你要反复引用它们的时候。这些类型可以在其它标签内使用,如 @type 和 @param。
📄️ @variation
有时代码可能包含多个具有相同长名称的符号。例如,您可能同时拥有一个全局类和一个名为 Widget 的顶级命名空间。在这种情况下,{@link Widget} 或 @memberof Widget 是什么意思?全局命名空间,还是全局类?
📄️ @version
@version 标签后面的文本将被用于表示该项的版本。
📄️ @yields
@yields 标记记录生成器函数生成的值。JSDoc 3.5.0 及更高版本中提供了此标记。