使用 JSDoc - JSDoc 中文

概述

使用 @inner 标记将标记一个符号为其父符号的内部成员。这意味着它可以通过“父级~子级”来引用。

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

使用 @inner 将一个虚拟文档设为内部成员

/** @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。