@inner

.. @inner::

语法

@inner

概述

使用@inner标记会将符号标记为其父符号的内部成员. 这意味着它可以被“Parent-Child”引用.

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

示例

Using @inner to make a virtual doclet an inner member

/** @namespace MyNamespace */
/**
 * myFunction is now MyNamespace~myFunction.
 * @function myFunction
 * @memberof MyNamespace
 * @inner
 */

请注意, 在上面我们可以使用“@function MyNamespace~myFunction”而不是@memberof和@inner标签.

Using @inner

/** @namespace */
var MyNamespace = {
    /**
     * foo is now MyNamespace~foo rather than MyNamespace.foo.
     * @inner
     */
    foo: 1
};

在上面的示例中, 我们使用@inner强制将命名空间的成员记录为内部成员(默认情况下, 它将是一个静态成员). 这意味着``foo``现在有了长名``MyNamespace~foo``而不是``MyNamespace.foo``.