同義語

• const

構文

@constant [<type> <name>]

概要

@constant タグは、定数のシンボルに属するドキュメントにマークを付けるために使用されます。

例

この例では、文字列定数の説明をしています。コードでは const キーワードを使用していますが、JSDoc では必須ではありません。ご使用の JavaScript ホスト環境がまだ定数の宣言をサポートしていない場合でも、@const は var 宣言で使用できる非常に効果的なドキュメントと言えます。

/** @constant
    @type {string}
    @default
*/
const RED = 'FF0000';

/** @constant {number} */
var ONE = 1;

この例では @type タグで型を提供しています。これはオプションです。オプションの @default タグもここで使用されており、自動的に割り当てられた値（例: 'FF0000'）をドキュメントに追加します。

関連するリンク

• @default
• @type