JSDoc中是否支持一次性为多个变量指定相同类型?
JSDoc 一次性为多个变量指定相同类型的写法
使用JSDoc做JavaScript类型标注时,不需要为每个同类型变量逐行编写@type声明,有可直接使用的简化方案,VS Code、WebStorm等主流编辑器的类型检查、JSDoc官方解析工具、TSServer都能正常识别:
- 单条声明语句批量绑定类型
这是兼容性最好、最常用的写法:将同类型的变量放在同一条var/let/const声明语句中,只需要在语句前添加一次@type标注,语句内所有声明的变量都会被识别为指定类型。
示例:/** @type {number} */ var a = 1, b = 2; /** @type {string} */ let username = "li", address = "hangzhou", phone = "138xxxx"; - 解构赋值场景批量标注
如果用数组解构方式声明变量,可以通过标注元组类型,一次性为所有解构出的变量绑定对应类型:// posX、posY都会被识别为number类型 /** @type {[number, number]} */ const [posX, posY] = [120, 30];
注意:原生JSDoc目前不支持跨多条独立声明语句的批量类型标注。如果同类型变量被拆分为多条独立的声明行,要么将其合并到同一条声明语句中用上述方法简化,要么只能逐行添加
@type标注。
内容的提问来源于stack exchange,提问作者Jeong Seong Jin
相关产品推荐
相关产品推荐

