@use JSDoc

概要

@readonly タグはシンボルが読み取り専用であることを示します。これはドキュメンテーションの目的でのみ使用され、JSDoc は 実際に コードでシンボルを readonly として扱っているかどうかを確認しません。

例

@readonly タグを使用する
/**
 * A constant.
 * @readonly
 * @const {number}
 */
const FOO = 1;
@readonly タグをゲッターと一緒に使用する
/**
 * 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';
	}
};