JSDoc中文文档(@use JSDoc)

JSDoc @constant 标签

目录

同义词

JSDoc @const 标签

语法

@constant [<type> <name>]

描述

@constant 标签指明这个对象是一个常量。

示例

在这个实例中我们记录一个字符串常量。注意，虽然代码使用const关键字，对于JSDoc来说，这不是必需的。如果你的JavaScript宿主环境尚不支持常量声明，@const描述可以很有效地用在var声明上。

示例: 一个字符串常量表示红色
/** @constant
    @type {string}
    @default
*/
const RED = 'FF0000';

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

注意，实例中在@type标签中提供了一个类型。是可选的。另外可选的@default标签用在这里也一样，这里将自动添加任何指定的值（例如， 'FF0000'）给文档。