@use JSDoc

概要

@inner タグを使うと、シンボルが、親シンボルの内部メンバーであることになります。これは、「Parent~Child」で参照されることを意味します。

@inner を使うと、ドキュレットのデフォルトのスコープをオーバーライドできます（ただし、グローバルスコープにある場合はグローバルスコープのままです）。

例

@inner を使って仮想ドキュレットを内部メンバーにする
/** @namespace MyNamespace */
/**
 * myFunction is now MyNamespace~myFunction.
 * @function myFunction
 * @memberof MyNamespace
 * @inner
 */

上の例では、@memberof と @inner タグの代わりに「@function MyNamespace~myFunction」を使っても同じ結果が得られます。

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

上の例では、@inner を使って名前空間のメンバーを内部メンバーとしてドキュメント化しています（デフォルトでは静的メンバーになります）。この場合、foo には、MyNamespace.foo の代わりに、MyNamespace~foo というロングネームが付けられます。