@instance

.. @instance::

语法

@instance

概述

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

使用@instance将覆盖doclet的默认范围(除非它在全局范围内, 在这种情况下它将保持全局).

示例

以下示例是编写“@function MyNamespace＃myFunction”的简便方法:

Using @instance to make a virtual doclet an instance member

/** @namespace MyNamespace */
/**
 * myFunction is now MyNamespace#myFunction.
 * @function myFunction
 * @memberof MyNamespace
 * @instance
 */

更有用的是, 您可以使用@instance标记来覆盖JSDoc推断的范围. 例如, 您可以指示静态成员用作实例成员:

Using @instance to identify an instance member

/** @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);
}