在 JavaScript 中，Symbol 是一种新的原始数据类型，它可以作为对象属性的键值，具有唯一性、不可变性以及不可枚举性等特点。但是，由于 Symbol 是一种非常简洁的数据类型，因此在代码中使用时往往不太好辨认。为了解决这个问题，ECMAScript 2019 中增加了 Symbol.prototype.description 属性，用于增强 Symbol 的可读性。
Symbol.prototype.description 简介
Symbol.prototype.description 是 Symbol 实例上的一个访问器属性，用于获取 Symbol 实例的描述信息。描述信息是一个可选的字符串参数，在创建 Symbol 实例时可以传入。如果未传入该参数，则默认为空字符串。例如：
const symbol = Symbol('hello');
console.log(symbol.description); // 'hello'Symbol.prototype.description 的作用
通过 Symbol.prototype.description，可以方便地查看 Symbol 实例的描述信息，以便在代码中更好地理解其含义。例如，在以下代码中，我们创建了两个 Symbol 实例，分别表示用户的账号和密码：
-- -------------------- ---- ------- ----- ------- - --------------- ----- ----------- - ------------------- ----- ---- - - ---------- -------- -------------- -------- -- --------------------------- -- ------- --------------------------------- --------
上述代码中，如果没有使用 Symbol.prototype.description，我们就很难知道 userKey 和 passwordKey 分别代表什么含义，这样就会影响代码的可读性和可维护性。
但是，有了 Symbol.prototype.description，我们就可以轻松地通过描述信息，快速地理解 Symbol 实例的含义。例如，我们可以将上面的代码改写成：
-- -------------------- ---- ------- ----- ------- - ------------ ------ ----- ----------- - ---------------- ------ ----- ---- - - ---------- -------- -------------- -------- -- --------------------------- -- ------- --------------------------------- --------
这样，不仅代码更加直观了，而且也更容易被其他开发者理解。
Symbol.prototype.description 的注意事项
需要注意的是，Symbol.prototype.description 只能用于访问 Symbol 实例的描述信息，不能用于改变 Symbol 实例的属性值。例如：
const symbol = Symbol('hello');
symbol.description = 'hi'; // 报错：Cannot assign to read only property 'description' of symbol 'Symbol(hello)'同时，Symbol.prototype.description 也只能用于访问具有描述信息的 Symbol 实例，对于未定义描述信息的 Symbol 实例，访问 Symbol.prototype.description 会返回 undefined。例如：
const symbol = Symbol(); console.log(symbol.description); // undefined
总结
Symbol.prototype.description 是 ECMAScript 2019 中的一个新特性，它可以增强 Symbol 类型的可读性，方便开发者理解代码。通过描述信息，我们可以快速地知道 Symbol 实例所代表的含义，从而让代码更加清晰、简洁和易于维护。
值得一提的是，在 Node.js 10.x 及以下版本中，未支持 Symbol.prototype.description 特性，如果需要使用该特性，则需要在代码中手动引入一个 polyfill。例如，可以使用 core-js 包中的 Symbol.description 实现，引入方式为：
require('core-js/features/symbol/description');来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64a09eb048841e9894cea475