@constant (synonyms: @const)¶

.. @constant::¶

同义词

@const

语法

@constant [<type> <name>]

概述

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

示例

在这个例子中, 我们记录了一个字符串常量. 请注意, 尽管代码使用的是``const``关键字, 但JSDoc并不需要这样做. 如果您的JavaScript主机环境还不支持常量声明, 那么@const文档可以有效地用于``var``声明.

A string constant representing the color red¶

/** @constant
    @type {string}
    @default
*/
const RED = 'FF0000';

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

请注意, 该示例提供了@type标记中的类型. 这是可选的. 此外, 此处也使用了可选的@default标记, 这将自动将指定值的任何内容(例如“FF0000”)添加到文档中.

.. @const::¶