0

0

JS注解怎么做类型检查_ JS注解配合类型检查工具的使用方法

星夢妙者

星夢妙者

发布时间:2025-11-08 14:25:25

|

750人浏览过

|

来源于php中文网

原创

使用JSDoc注解配合// @ts-check或jsconfig.json可在JavaScript中实现类型检查,提升代码质量。1. 通过JSDoc为变量、函数等添加类型提示;2. VS Code内置支持,可直接显示类型错误;3. 配置jsconfig.json启用全项目检查;4. 支持基础类型、数组、对象、函数及自定义类型别名,无需迁移TypeScript即可获得静态类型检查能力。

js注解怎么做类型检查_ js注解配合类型检查工具的使用方法

JS注解本身不会执行类型检查,它只是为类型检查工具提供提示信息。要在JavaScript中实现类型检查,需要结合像 FlowTypeScript 这样的工具。其中,使用JS注解配合 JSDoc 是一种在原生JS中添加类型信息的常用方式,尤其适用于不想完全迁移到TypeScript的项目。

1. 使用JSDoc添加类型注解

JSDoc是一种在JavaScript代码中写文档注释的标准方式,同时也被许多类型检查工具和编辑器用来推断变量类型。

通过在注释中使用特定标签,可以为变量、函数参数、返回值等指定类型。

示例:

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

上面的注解告诉类型检查工具或IDE:a 和 b 应该是 number 类型,返回值也是 number。

2. 配合 VS Code 实现类型提示

Visual Studio Code 内置了对 JSDoc 类型注解的支持,无需额外配置即可获得一定程度的类型检查和智能提示。

只要在 JS 文件中正确书写 JSDoc 注解,VS Code 就能识别并提示类型错误。

例子:

// @ts-check

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

greet(123); // VS Code 会在此行报错:类型 'number' 不能赋给类型 'string'

注意:// @ts-check 是开启当前文件类型检查的指令,加上后 VS Code 会主动检查类型是否匹配。

微信 WeLM
微信 WeLM

WeLM不是一个直接的对话机器人,而是一个补全用户输入信息的生成模型。

下载

3. 在项目中启用更严格的类型检查

如果希望在整个项目中启用基于 JSDoc 的类型检查,可以在项目根目录创建 jsconfig.json 文件进行配置。

jsconfig.json 示例:

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

关键配置说明:

  • checkJs: true —— 启用对 .js 文件的类型检查
  • noEmit: true —— 不生成输出文件,仅用于检查
  • strict: true —— 开启严格模式,包括类型推断和错误检测

配置完成后,所有包含 JSDoc 注解的 JS 文件都会被检查,帮助发现潜在的类型问题。

4. 支持的 JSDoc 类型语法

JSDoc 支持多种类型表达式,常见用法包括:

  • @param {string} —— 参数为字符串
  • @param {Array}@param {number[]} —— 数组类型
  • @param {Object} —— 对象类型
  • @param {{name: string, age: number}} —— 匿名对象结构
  • @param {(a: number) => boolean} —— 函数类型
  • @typedef —— 定义自定义类型别名
使用 @typedef 定义复杂类型:

/\*\*
 \* @typedef {Object} User
 \* @property {string} name
 \* @property {number} age
 \* @property {boolean} isActive
 \*/

/** * @param {User} user */ function logUser(user) { console.log(user.name); }

基本上就这些。通过 JSDoc 注解 + // @ts-checkjsconfig.json,你可以在纯 JavaScript 项目中实现有效的类型检查,提升代码健壮性和可维护性,而无需引入 TypeScript 编译流程。

相关专题

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

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

539

2023.06.20

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

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

372

2023.07.04

js四舍五入
js四舍五入

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

727

2023.07.04

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

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

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

391

2023.09.04

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

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

989

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

653

2023.09.12

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

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

541

2023.09.20

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

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

精品课程

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

共48课时 | 6.2万人学习

Django 教程
Django 教程

共28课时 | 2.6万人学习

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

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