JSDoc中文文档(@use JSDoc)

JSDoc @default 标签

目录

同义词

JSDoc @defaultvalue 标签

语法

@default [<some value>]

概述

@default标签可以让你记录标识的赋值。可以在标签后面跟上他的值,或者当值是一个唯一被分配的简单值(可以是:一个字符串,数字,布尔值或null)的时候,你可以让JSDoc从源代码中获取值,自动记录 。

示例

在本实例中,一个常量被记录。该常数的值为0xff0000。通过添加@default标签,这个值将自动添加到文档。

示例: 记录一个常量的数值
/**
 *  @constant
 *  @default
 */
const RED = 0xff0000;