@default (synonyms: @defaultvalue)¶

.. @default::¶

同义词

@defaultvalue

语法

@default [<some value>]

概述

@default标记允许您记录符号的指定值. 您可以自己为此标记提供值, 或者您可以允许JSDoc自动记录源代码中的值 - 只有在为文档化的符号分配一个简单的值时才有可能: 字符串, 数字, 布尔值或者为null.

示例

在此示例中, 记录了常量. 常量的值是``0xff0000``. 通过添加@default标记, 此值将自动添加到文档中.

Document the number value of a constant¶

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

.. @defaultvalue::¶