@use JSDoc

構文

JSDocタグディクショナリ（ デフォルトで有効）を使用する

@private

Closure Compilerタグディクショナリを使用する

@private [{typeExpression}]

概要

@privateタグは、シンボルをプライベート、つまり一般には使用しないことを示します。JSDocは、-p/--privateコマンドラインオプションによって実行される場合を除き、生成的出力にプライベートメンバを表示しません。JSDoc 3.3.0以降では、-a/--accessコマンドラインオプションを使用してこの動作を変更することもできます。

@privateタグは子メンバから継承されません。たとえば、@privateタグが名前空間に追加された場合、名前空間のメンバは生成された出力に表示される可能性があります。名前空間はプライベートであるため、メンバのネームパスには名前空間は含まれません。

@privateタグは@access privateと同等です。

例

以下の例では、DocumentsとDocuments.Newspaperは生成されたドキュメントに表示されますが、Documents.Diaryは表示されません。

@privateタグを使用する
/** @namespace */
var Documents = {
    /**
     * An ordinary newspaper.
     */
    Newspaper: 1,
    /**
     * My diary.
     * @private
     */
    Diary: 2
};