@constant
优质
小牛编辑
127浏览
2023-12-01
描述: 记录一个对象作为一个常量。
别名:@const
Syntax(语法)
@constant [<type> <name>]
Overview(概述)
@constant 标签指明这个对象是一个常量。
Examples(例子)
在这个实例中我们记录一个字符串常量。注意,虽然代码使用const
关键字,对于JSDoc来说,这不是必需的。如果你的JavaScript宿主环境尚不支持常量声明,@const
描述可以很有效地用在var
声明上。
例如,一个字符串常量表示红色:
/** @constant @type {string} @default */ const RED = 'FF0000'; /** @constant {number} */ var ONE = 1;
注意,实例中在@type
标签中提供了一个类型。是可选的。另外可选的@default
标签用在这里也一样,这里将自动添加任何指定的值(例如, 'FF0000')给文档。