同义词

• defaultvalue

语法

@default [<some value>]

概述

@default 标签允许您记录符号的已分配值。您可以自己使用此标签提供值，或者允许 JSDoc 从源代码自动记录值——仅当记录的符号被分配一个简单的值时才有可能：字符串、数字、布尔值或 null。

示例

在此示例中，记录了一个常量。常量的值为 0xff0000。通过添加 @default 标签，此值会自动添加到文档中。

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