讲师中心 微信公众号

工具推荐

视频效率加速
Seko
Seko

AI短剧一键生成成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

AniShort
AniShort

AI短剧协同制作平台

VSCode中的JSDoc注释与类型检查

云雪君_5872

云雪君_5872

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

|

672人浏览过

|

来源于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<number></number>
  • 函数类型可写为 /** @type {(x: number) => string} */ 或更清晰的 /** @type {import('./types').Callback} */

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

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

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载
  • 在 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 都能被完美解析,遇到提示不准时可尝试:

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

它不是 TypeScript,但足够好用

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

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

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

墨刀AI
墨刀AI Hot

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

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

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

DeepSeek

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

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

相关专题

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

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

332

2026.02.13

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

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

540

2026.02.25

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

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

411

2026.03.13

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

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

326

2026.06.03

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

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

738

2026.06.16

json数据格式
json数据格式

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

2295

2023.08.07

json是什么
json是什么

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

3782

2023.08.23

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

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

1256

2023.10.13

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

60

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.5万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习

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

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