JS注解怎么标注联合类型_ JS联合类型的注解书写与使用技巧

新闻中心 NEWS CENTER

您当前位置：首页 > 新闻中心 > 网络学院

JS注解怎么标注联合类型_ JS联合类型的注解书写与使用技巧

2025-11-04

浏览次数：次

返回列表

在J*aScript中可通过JSDoc使用联合类型注解，如string|number表示多类型支持，结合@param、@typedef等标签提升代码可读性与编辑器提示，适用于函数参数、返回值等场景。

js注解怎么标注联合类型_ js联合类型的注解书写与使用技巧

在J*aScript中，虽然原生不支持类型注解，但在使用JSDoc配合现代编辑器（如VS Code）或TypeScript时，可以通过注解方式为变量、函数参数等添加联合类型说明，提升代码可读性和开发体验。下面介绍JS中如何正确书写和使用联合类型的JSDoc注解。

什么是联合类型注解

联合类型表示一个值可以是多种类型中的一种。在JSDoc中，使用 | 符号连接多个类型，形成联合类型。这种方式常用于函数参数、返回值或变量声明的类型标注。

例如，一个参数可以是字符串或数字：

/** * @param {string|number} value - 可以是字符串或数字 */ function logValue(value) { console.log(value); }

常见联合类型写法与技巧

掌握几种典型的联合类型写法，有助于更准确地描述API行为。

基础类型联合：string、number、boolean等组合使用

/** * @param {string|number|boolean} input */ function processInput(input) { ... }

对象类型联合：不同结构的对象可以共存

/** * @param {{type: 'success', data: any} | {type: 'error', message: string}} result */ function handleResult(result) { if (result.type === 'success') { // 处理成功逻辑 } else { // 处理错误逻辑 } }

包含 null 和 undefined：显式允许空值

/** * @param {string|null|undefined} name */ function greet(name) { if (name) { console.log('Hello, ' + name); } else { console.log('Hello, anonymous'); } }