@use JSDoc

構文

@access <package|private|protected|public>

概要

@access タグは、メンバーのアクセス レベルを指定します。@access タグは、他のタグの同義語として使用できます

プライバシー メンバーは、JSDoc がコマンドライン オプション -p/--private を使用して実行されない限り、生成された出力に表示されません。JSDoc 3.3.0 以降では、-a/--access コマンドライン オプションを使用してこの動作を変更することもできます。

ドキュメントのアクセス レベルは、スコープとは異なります。たとえば、Parent に @public とドキュメント化されている child という内部変数がある場合、child 変数は依然として namepath Parent~child の内部変数として扱われます。言い換えると、child 変数は、変数が公開されているにもかかわらず、内部スコープを持ちます。Doclet のスコープを変更するには、@instance、@static、および @global の各タグを使用します。

例

@access を他のタグの同義語として使用
/** @constructor */
function Thingy() {

    /** @access private */
    var foo = 0;

    /** @access protected */
    this._bar = 1;

    /** @access package */
    this.baz = 2;

    /** @access public */
    this.pez = 3;

}

// same as...

/** @constructor */
function OtherThingy() {

    /** @private */
    var foo = 0;

    /** @protected */
    this._bar = 1;

    /** @package */
    this.baz = 2;

    /** @public */
    this.pez = 3;

}