0

0

JS注解怎么进行动态类型标注_ JS动态类型参数的注解处理与使用

絕刀狂花

絕刀狂花

发布时间:2025-11-09 08:24:03

|

347人浏览过

|

来源于php中文网

原创

JSDoc可通过类型注解为JavaScript提供静态类型提示,提升代码可读性与IDE智能感知能力。1. 使用@param、@returns等标签标注函数参数与返回值类型;2. 支持对象结构、数组、联合类型等复杂类型描述;3. 通过@typedef定义复用类型;4. 添加// @ts-check或配置jsconfig.json启用类型检查;5. 利用@template实现泛型推断。该方式不改变运行时行为,适合渐进式优化项目类型安全。

js注解怎么进行动态类型标注_ js动态类型参数的注解处理与使用

JavaScript 本身是动态类型语言,不支持传统意义上的类型注解。但在使用像 TypeScript 或支持 JSDoc 的开发环境(如 VSCode、IDEA)时,可以通过 JSDoc 注解为 JS 提供静态类型提示,实现“动态类型标注”的效果。这种方式不会改变运行时行为,但能提升代码可读性与 IDE 智能提示能力。

JSDoc 类型注解基础语法

在函数或变量前使用 JSDoc 注释块,可以明确参数、返回值的类型:

/** * 计算两数之和 * @param {number} a - 第一个数字 * @param {number} b - 第二个数字 * @returns {number} 和值 */ function add(a, b) { return a + b; }

IDE 能根据注解识别 a、b 必须为 number 类型,调用时提供自动补全与错误提示。

支持复杂与动态类型的注解方式

JS 中常处理对象、数组、联合类型等复杂结构,JSDoc 提供多种标签满足需求:

  • @param {Object} 可细化为具体结构:{ name: string, age: number }
  • @param {Array}@param {string[]} 标注字符串数组
  • @param {number | string} 表示参数可以是数字或字符串(联合类型)
  • @param {*} value 表示任意类型,适合泛用函数
  • @typedef 定义自定义类型,提高复用性

/**

  • @typedef {Object} User
  • @property {string} name
  • @property {number} age
  • @property {boolean} active - 是否激活 */

/**

  • 更新用户状态
  • @param {User} user - 用户对象
  • @returns {User} 新用户实例 */ function updateUser(user) { return { ...user, active: true }; }

启用类型检查与工具支持

要在纯 JS 文件中启用类型检查,可在文件顶部添加 // @ts-check,让支持 TS 的编辑器对 JSDoc 类型进行校验:

快剪辑
快剪辑

国内⼀体化视频⽣产平台

下载
// @ts-check

/**

  • @param {string} str */ function greet(str) { console.log("Hello, " + str); }

greet(123); // 编辑器会报错:number 不能赋给 string

也可在项目根目录添加 jsconfig.json 配置文件,统一开启类型检查:

{ "compilerOptions": { "checkJs": true }, "include": ["src/**/*"] }

动态类型场景下的灵活处理

某些函数需要根据输入类型返回不同结构(类似多态),可通过联合类型或泛型模拟:

  • 使用 @param {object} options 并结合属性判断实现逻辑分支
  • @template T 实现泛型效果(TS 支持)

/**

  • @template T
  • @param {T} value
  • @returns {T} */ function identity(value) { return value; }

const n = identity(100); // 类型推断为 number const s = identity("hello"); // 类型推断为 string

基本上就这些。通过 JSDoc 结合现代开发工具,可以在不引入 TypeScript 编译的前提下,实现接近静态类型的开发体验,尤其适合渐进式迁移或轻量级项目。关键在于规范注解书写,让动态类型更“可预测”。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

554

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

731

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

477

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

991

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

C++ 单元测试与代码质量保障
C++ 单元测试与代码质量保障

本专题系统讲解 C++ 在单元测试与代码质量保障方面的实战方法,包括测试驱动开发理念、Google Test/Google Mock 的使用、测试用例设计、边界条件验证、持续集成中的自动化测试流程,以及常见代码质量问题的发现与修复。通过工程化示例,帮助开发者建立 可测试、可维护、高质量的 C++ 项目体系。

5

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 7.2万人学习

Django 教程
Django 教程

共28课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号