JSDoc注释规范

/**
 * @abstract  (同义：@virtual)
 * 该成员必须由继承者实现（或重写）
 * This member must be implemented (or overridden) by the inheritor.
 * 
 * @access
 * 指定此成员的访问级别（私有，程序包私有，公共或受保护）。
 * Specify the access level of this member (private, package-private, public, or protected).
 * 
 * @alias
 * 将成员视为具有不同的名称。
 * Treat a member as if it had a different name.
 * 
 * @async
 * 表示一个函数是异步的。
 * Indicate that a function is asynchronous.
 * 
 * @augments
 * 指示符号从父符号继承并添加到父符号。
 * Indicate that a symbol inherits from, and adds to, a parent symbol.
 * 
 * @author
 * 标识项目的作者。
 * Identify the author of an item.
 * 
 * @borrows
 * 该对象使用来自另一个对象的东西
 * This object uses something from another object.
 * 
 * @callback
 * 记录回调函数。
 * Document a callback function.
 * 
 * @class (同义：@constructor)
 * 该功能旨在通过"new"关键字来调用。
 * This function is intended to be called with the "new" keyword.
 * 
 * @classdesc
 * 使用以下文本描述整个类
 * Use the following text to describe the entire class.
 * 
 * @constant (同义：@const)
 * 将对象记录为常量
 * Document an object as a constant.
 * 
 * @constructs
 * 该函数成员将是上一类的构造函数
 * This function member will be the constructor for the previous class.
 * 
 * @copyright
 * 记录一些版权信息
 * Document some copyright information.
 * 
 * @default
 * 记录默认值
 * Document the default value.
 * 
 * @deprecated
 * 记录这不再是首选方法
 * Document that this is no longer the preferred way.
 * 
 * @description (同义：@desc)
 * 描述一个符号
 * Describe a symbol.
 * 
 * @enum
 * 记录相关属性的集合
 * Document a collection of related properties.
 * 
 * @event
 * 记录事件
 * Document an event.
 * 
 * @example
 * 提供有关如何使用已记录项目的示例
 * Provide an example of how to use a documented item.
 * 
 * @exports
 * 标识由JavaScript模块导出的成员
 * Identify the member that is exported by a JavaScript module.
 * 
 * @external(同义：@host)
 * 标识外部类，名称空间或模块
 * Identifies an external class, namespace, or module.
 * 
 * @file(同义：@fileoverview,@overview)
 * 描述一个文件
 * Describe a file.
 * 
 * @fires(同义：@emits)
 * 描述此方法可能触发的事件
 * Describe the events this method may fire.
 * 
 * @function(同义：@function,@method)
 * 描述一个函数或方法
 * Describe a function or method.
 * 
 * @generator
 * 表示函数是生成器函数
 * Indicate that a function is a generator function.
 * 
 * @global
 * 记录全局对象
 * Document a global object.
 * 
 * @hideconstructor
 * 指示不应显示构造函数
 * Indicate that the constructor should not be displayed.
 * 
 * @ignore
 * 省略文档中的符号
 * Omit a symbol from the documentation.
 * 
 * @implements
 * 该符号实现一个​​接口
 * This symbol implements an interface.
 * 
 * @inheritdoc
 * 指示符号应继承其父级的文档
 * Indicate that a symbol should inherit its parent's documentation.
 * 
 * @inner
 * 记录内部对象
 * Document an inner object.
 * 
 * @instance
 * 记录实例成员
 * Document an instance member.
 * 
 * @interface
 * 此符号是其他人可以实现的接口
 * This symbol is an interface that others can implement.
 * 
 * @kind
 * 这是什么符号 
 * What kind of symbol is this?
 * 
 * @lends
 * 在对象文字上记录属性，就好像它们属于具有给定名称的符号一样
 * Document properties on an object literal as if they belonged to a symbol with a given name.
 * 
 * @license
 * 标识适用于此代码的许可证
 * Identify the license that applies to this code.
 * 
 * @listens
 * 列出符号侦听的事件
 * List the events that a symbol listens for.
 * 
 * @member
 * 记录成员
 * Document a member.
 * 
 * @memberof
 * 该符号属于父符号 
 * This symbol belongs to a parent symbol.
 * 
 * @mixes
 * 该对象混合了另一个对象的所有成员
 * This object mixes in all the members from another object.
 * 
 * @mixin
 * 记录一个混合对象
 * Document a mixin object.
 * 
 * @module
 * 编写一个JavaScript模块
 * Document a JavaScript module.
 * 
 * @name
 * 记录对象的名称
 * Document the name of an object.
 * 
 * @namespace
 * 记录名称空间对象
 * Document a namespace object.
 * 
 * @override
 * 指示符号覆盖其父代
 * Indicate that a symbol overrides its parent.
 * 
 * @package
 * 此符号是软件包专用的
 * This symbol is meant to be package-private.
 * 
 * @param(同义：@arg,@argument)
 * 将参数记录到函数中
 * Document the parameter to a function.
 * 
 * @private
 * 此符号是专用的
 * This symbol is meant to be private.
 * 
 * @property(同义：@prop)
 * 记录对象的属性
 * Document a property of an object.
 * 
 * @protected
 * 此符号用于保护
 * This symbol is meant to be protected.
 * 
 * @public
 * 此符号是公开的
 * This symbol is meant to be public.
 * 
 * @readonly
 * 该符号是只读的
 * This symbol is meant to be read-only.
 * 
 * @requires
 * 该文件需要一个JavaScript模块
 * This file requires a JavaScript module.
 * 
 * @returns
 * 记录函数的返回值
 * Document the return value of a function.
 * 
 * @see
 * 有关更多信息，请参考其他一些文档
 * Refer to some other documentation for more information.
 * 
 * @since
 * 何时添加此功能
 * When was this feature added?
 * 
 * @static
 * 记录静态成员
 * Document a static member.
 * 
 * @summary
 * 完整说明的简短版本
 * A shorter version of the full description.
 * 
 * @this
 * "this"关键字在这里指的是什么
 * What does the 'this' keyword refer to here?
 * 
 * @throws(同义：@exception)
 * 描述可能引发的错误
 * Describe what errors could be thrown.
 * 
 * @todo
 * 记录要完成的任务
 * Document tasks to be completed.
 * 
 * @tutorial(教程)
 * 插入指向随附的教程文件的链接
 * Insert a link to an included tutorial file.
 * 
 * @type
 * 记录对象的类型
 * Document the type of an object.
 * 
 * @typedef
 * 记录自定义类型
 * Document a custom type.
 * 
 * @variation
 * 区分具有相同名称的不同对象
 * Distinguish different objects with the same name.
 * 
 * @version
 * 记录项目的版本号
 * Documents the version number of an item.
 * 
 * @yields(同义：@yield)
 * 记录生成器函数产生的值
 * Document the value yielded by a generator function.
 * 
 */