@constant (@const)【定数値】
@readonly【読み取り専用】
@enum【列挙子】
@default (@defaultvalue)【デフォルト値】

@constant (@const)【定数値】

メモ

  • 定数値を記述
    • const の場合、省略可
    • @enum【列挙子】 と併用すると、@constant【定数値】は無視
  • チェック・インライン化
    • 指定した型と一致しない場合、警告
    • 変更するコードがある場合、警告 (const 定義は、タグがなくてもエラー)
    • 変更不可の為、即値としてインライン展開
  • 関連

構文

@constant [ {型} ] 
シノニム：@const

@const [ {型} ]

例

/**
 * ON の定数
 * @const
 */
var ON = 1;

/**
 * OFF の数値定数
 * @const {number}
 */
var OFF = 0;

/**
 * ERROR の文字列定数
 * @const {string}
 */
var ERROR = "Error";

関連

@readonly【読み取り専用】

メモ

構文

@readonly

例

/**
 * フラグ
 * @readonly
 */
var flag = true;

関連

@enum【列挙子】

メモ

  • 列挙子を記述
  • チェック
    • 指定した型と一致しない場合、警告
  • 関連

構文

@enum [ {型} ]

型省略：number

例

/**
 * フラグ定義１
 * @enum
 */
var flag1 = {
  ON:    1,
  OFF:   0,
  ERROR: (-1)
};

/**
 * フラグ定義２
 * @readonly
 * @enum {number}
 */
var flag2 = {
  /** オンの説明   */ ON:    1,
  /** オフの説明   */ OFF:   0,
  /** エラーの説明 */ ERROR: (-1)
};

関連

@default (@defaultvalue)【デフォルト値】

メモ

構文

@default [ デフォルト値 ] 
シノニム：@defaultvalue

例

/**
 * フラグ
 * @default 0
 */
var flag;