JSDoc中文文档(@use JSDoc)

JSDoc @readonly 标签

目录

概述

@readonly标记一个标识符为只读。JSDoc不会检查某个代码是否真是只读的，只要标上@readonly，在文档中就体现为只读的。

示例

示例: 使用 @readonly 标签
/**
 * A constant.
 * @readonly
 * @const {number}
 */
const FOO = 1;
示例: 给getter标记为只读
/**
 * Options for ordering a delicious slice of pie.
 * @namespace
 */
var pieOptions = {
    /**
     * Plain.
     */
    plain: 'pie',
    /**
     * A la mode.
     * @readonly
     */
    get aLaMode() {
        return this.plain + ' with ice cream';
    }
};