@use JSDoc

概述

使用 @instance 标记会将符号标记为其父符号的实例成员。这意味着它可以通过“Parent#Child”引用。

使用 @instance 将覆盖说明文档的默认范围（除非它在全局范围内，在这种情况下它将保持全局）。

示例

以下示例是编写“@function MyNamespace#myFunction”的长格式方法

使用 @instance 将虚拟说明文档设为实例成员
/** @namespace MyNamespace */
/**
 * myFunction is now MyNamespace#myFunction.
 * @function myFunction
 * @memberof MyNamespace
 * @instance
 */

更实用的是，你可以使用 @instance 标记来覆盖 JSDoc 推断的范围。例如，你可以表明一个静态成员用作实例成员

使用 @instance 标识实例成员
/** @namespace */
var BaseObject = {
    /**
     * foo is now BaseObject#foo rather than BaseObject.foo.
     * @instance
     */
    foo: null
};

/** Generates BaseObject instances. */
function fooFactory(fooValue) {
	var props = { foo: fooValue };
	return Object.create(BaseObject, props);
}