@inner

优质

小牛编辑

133浏览

2023-12-01

描述: 描述一个内部对象。

Overview（概述）

使用@inner标签将标明该标识符作为它父标识符的内部成员。这意味着它可以通过 "Parent~Child" 被引用。

使用@inner将重写的doclet的默认范围（除非它是全局性的，在这种情况下将保持全局性）。

例如，使用@inner使一个虚拟的doclet作为内部成员：

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

请注意，在上面的代码我们也可以使用 "@function MyNamespace~myFunction"，代替@memberof和@inner标签。

例如，使用@inner：

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

在上面的例子中，我们使用@inner迫使一个命名空间的成员被描述作为内部成员（默认情况下，这是一个静态成员）。这意味着，foo现在有了MyNamespace~foo新名字，而不是MyNamespace.foo。