讲师中心 微信公众号
AI工具推荐 视频效率加速

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

雨枫大大_8687

雨枫大大_8687

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

|

770人浏览过

|

来源于php中文网

原创

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

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

JS注解本身不会执行类型检查,它只是为类型检查工具提供提示信息。要在JavaScript中实现类型检查,需要结合像 Flow 或 TypeScript 这样的工具。其中,使用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 就能识别并提示类型错误。

Scrapfly SDK TypeScript
Scrapfly SDK TypeScript

使用 Scrapfly SDK(scrapfly-sdk)在 TypeScript 或 JavaScript 中进行网页抓取,用于用户请求抓取 URL、绕过反爬虫防护、渲染页面等场景。

下载
例子:

// @ts-check
<p>/**
* @param {string} name
*/
function greet(name) {
console.log("Hello " + name);
}</p><p>greet(123); // VS Code 会在此行报错:类型 'number' 不能赋给类型 'string'

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

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
 \*/
<p>/**
* @param {User} user
*/
function logUser(user) {
console.log(user.name);
}

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

312

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

520

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

391

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

306

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

678

2026.06.16

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2195

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3482

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1176

2023.10.13

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

40

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
JavaScript OOP调试技巧视频教程
JavaScript OOP调试技巧视频教程

共5课时 | 1.1万人学习

WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.4万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn