0

0

VSCode中的JSDoc注释与类型检查

P粉986688829

P粉986688829

发布时间:2025-12-18 20:41:02

|

652人浏览过

|

来源于php中文网

原创

VSCode 通过集成 TypeScript 语言服务支持 JSDoc 类型推断,需规范书写 @param、@returns、@type 等标签,并启用 // @ts-check 或 jsconfig.json 中 "checkJs": true 才能触发类型检查。

vscode中的jsdoc注释与类型检查

VSCode 本身不直接执行类型检查,但它通过集成 TypeScript(或 JS 语言服务)来提供基于 JSDoc 的类型推断、智能提示和轻量级类型校验。关键在于正确书写 JSDoc,并启用相关设置。

JSDoc 注释怎么写才被识别

VSCode(借助 TypeScript 语言服务)能从 JSDoc 中提取类型信息,但格式必须规范:

  • 使用 @param 标注函数参数类型,如 /** @param {string} name */
  • @returns@return 说明返回值,如 /** @returns {number} 总长度 */
  • @type 给变量或属性标注类型,如 /** @type {Date} */ const now = new Date();
  • 支持复杂类型:对象字面量 {name: string, age: number}、数组 string[]、联合类型 string | null、泛型 Array
  • 函数类型可写为 /** @type {(x: number) => string} */ 或更清晰的 /** @type {import('./types').Callback} */

让类型检查真正起作用的关键设置

默认 JS 文件不会报类型错误,需主动开启检查:

  • 在 JS 文件顶部加 // @ts-check —— 启用当前文件的类型检查(推荐按需开启)
  • 或在项目根目录建 jsconfig.json,启用全项目检查:
    { "compilerOptions": { "checkJs": true } }
  • 确保 VSCode 工作区启用了 TypeScript 服务:打开命令面板(Ctrl+Shift+P),运行 “TypeScript: Select TypeScript Version” → 选 “Use Workspace Version”(如果装了本地 ts)或 “Use VS Code’s Version”
  • 禁用其他可能干扰的插件(如某些旧版 JavaScript 插件)

常见问题与绕过技巧

不是所有 JSDoc 都能被完美解析,遇到提示不准时可尝试:

XPaper Ai
XPaper Ai

AI撰写论文、开题报告生成、AI论文生成器尽在XPaper Ai论文写作辅助指导平台

下载
  • 类型别名太长?用 @typedef 提前定义,再在 @type 中引用
  • 第三方库无类型?加 /// 或在 jsconfig.jsontypes 字段中声明
  • 某个变量类型推断失败?补上显式 /** @type {...} */ 注释,比 let x = /** @type {...} */ (y) 更稳定
  • 想临时忽略某行检查?加 // @ts-ignore(慎用,仅调试)

它不是 TypeScript,但足够好用

JSDoc + checkJs 不提供编译、interfaceenum 等完整 TS 功能,但对纯 JS 项目来说,它提供了接近 TS 的编辑体验:跳转到定义、重命名、错误高亮、自动补全。不需要改后缀、不引入构建步骤,适合渐进式迁移或轻量脚本。

基本上就这些 —— 写对 JSDoc,开对开关,VSCode 就会默默帮你把类型“看”得清清楚楚。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

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

419

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

463

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

236

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

458

2024.03.01

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

531

2023.09.20

clawdbot ai使用教程 保姆级clawdbot部署安装手册
clawdbot ai使用教程 保姆级clawdbot部署安装手册

Clawdbot是一个“有灵魂”的AI助手,可以帮用户清空收件箱、发送电子邮件、管理日历、办理航班值机等等,并且可以接入用户常用的任何聊天APP,所有的操作均可通过WhatsApp、Telegram等平台完成,用户只需通过对话,就能操控设备自动执行各类任务。

2

2026.01.29

热门下载

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

精品课程

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

共58课时 | 4.3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.1万人学习

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

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