如何使用JSDoc为多个解构变量添加废弃通知？

直接在解构导出的语句上贴@deprecated注释没用，因为JSDoc没法把这个标记关联到每个拆出来的变量上，IDE自然不会给出废弃警告。可以用以下两种方式批量处理：

方法一：先解构再批量导出（推荐） #

先把所有变量解构到局部，再逐个导出并复用同一段废弃提示文本，既不用重复写注释内容，又能让每个变量都被IDE识别为废弃状态：

// 定义复用的废弃提示，避免重复编写
const DEPRECATED_COLOR_TIP = '这些颜色变量已废弃';

// 先解构到本地变量
const { color1, color2, color3 /* ...这里放更多变量 */ } = mainColors;

/** @deprecated {DEPRECATED_COLOR_TIP} */
export { color1 };
/** @deprecated {DEPRECATED_COLOR_TIP} */
export { color2 };
/** @deprecated {DEPRECATED_COLOR_TIP} */
export { color3 };
// 剩下的变量依葫芦画瓢就行

如果觉得逐个写export太繁琐，也可以把所有废弃变量打包成一个对象，给整个对象加废弃注释——不过要注意，部分IDE可能需要开启额外配置才能识别对象内部属性的废弃状态：

/**
 * @deprecated 这些颜色变量已废弃
 * @type {{color1: string, color2: string, color3: string}}
 */
const deprecatedColors = { color1, color2, color3 /* ... */ };

export { deprecatedColors };

方法二：用类型定义绑定废弃标记 #

先通过@typedef定义一个带有废弃标记的类型，再把解构出来的变量关联到这个类型，适合需要同时做类型提示的场景：

/**
 * @deprecated 这些颜色变量已废弃
 * @typedef {Object} DeprecatedColors
 * @property {string} color1
 * @property {string} color2
 * @property {string} color3
 * // 继续添加其他变量的类型定义
 */

/** @type {DeprecatedColors} */
const { color1, color2, color3 /* ... */ } = mainColors;

export { color1, color2, color3 /* ... */ };

这种方法的废弃提示清晰度可能不如第一种，所以更推荐用方法一，确保每个变量的废弃状态都能被IDE准确识别。

内容的提问来源于stack exchange，提问作者artemean