@use JSDoc

同义词

语法

@constant [<type> <name>]

概述

@constant 标记用于将文档标记为属于常量的符号。

示例

在此示例中，我们记录了一个字符串常量。请注意，虽然代码使用的是 const 关键字，但这并不是 JSDoc 所必需的。如果您的 JavaScript 主机环境尚不支持常量声明，则 @const 文档同样可以有效地用于 var 声明。

表示颜色的字符串常量
/** @constant
    @type {string}
    @default
*/
const RED = 'FF0000';

/** @constant {number} */
var ONE = 1;

请注意，示例在 @type 标记中提供了类型。这是可选的。这里还使用了可选的 @default 标记，这会自动将分配的值（例如 'FF0000'）添加到文档中。