シノニム

• defaultvalue

構文

@default [<何かしらの値>]

概要

@default タグを使用すると、記号の割り当て値をドキュメント化できます。このタグには値を自分自身で提供することも、JSDoc にソースコードから自動的に値をドキュメント化させることもできます。ドキュメント化されている記号に、文字列、数値、ブール値、または null のいずれかの単一の単純な値が割り当てられている場合にのみ可能です。

例

この例では、定数をドキュメント化しています。定数の値は 0xff0000 です。@default タグを追加することで、この値はドキュメントに自動的に追加されます。

/**
 *  @constant
 *  @default
 */
const RED = 0xff0000;