0

0

VSCode中的JSDoc注释如何增强智能提示

P粉986688829

P粉986688829

发布时间:2025-12-08 10:07:03

|

918人浏览过

|

来源于php中文网

原创

JSDoc 注释本身不自动开启智能提示,但能增强类型推导与补全——需项目配置得当、注释规范:启用 jsconfig.json/tsconfig.json 或 // @ts-check,正确书写 @type/@param/@returns/@typedef 等标签,并确保路径与类型定义可被解析。

vscode 中的 jsdoc 注释本身不会自动“开启”智能提示,但它能显著增强 typescriptjavascript 文件中的类型推导与补全能力——前提是项目配置得当、注释写得规范。

确保启用了 JS/TS 语言服务

VSCode 默认对 .ts.tsx 文件启用完整类型检查,但对 .js 文件默认是轻量级的。要让 JSDoc 在 JS 文件中生效,需满足以下任一条件:

  • 项目根目录有 jsconfig.json(JS 项目)或 tsconfig.json(TS 项目),且配置了 "checkJs": true(JS)或已启用类型检查(TS)
  • 在 JS 文件顶部添加 // @ts-check 注释,临时启用类型检查
  • 确保 VSCode 的 “TypeScript and JavaScript Language Features” 插件已启用(默认内置,勿禁用)

写对 JSDoc 类型标注是关键

不是所有 JSDoc 都能触发提示,只有明确声明类型、参数、返回值等信息的注释才被语言服务识别。常见有效写法:

  • /** @type {string[]} */ const arr = []; → 变量类型提示立即生效
  • /** @param {number} id @param {string} name @returns {Promise} */ → 函数调用时显示参数名、类型和返回值
  • /** @typedef {{id: number, name: string}} User */ → 自定义类型,后续可复用:@type {User}
  • /** @extends {Map} */ class MyMap extends Map {} → 继承类也能获得父类方法提示

配合类型导入提升跨文件提示

如果类型定义在其他文件中(比如 types.jsuser.d.ts),JSDoc 也能引用:

  • /** @typedef {import('./types').Config} Config */ → 直接导入并起别名,后续 @type {Config} 即可获得完整提示
  • /** @type {import('axios').AxiosInstance} */ const http = axios.create(...); → 无需安装类型包,只要项目中有 @types/axios 或 ESM 类型声明

注意:路径必须正确,且目标文件需可被 TS/JS 语言服务解析(例如非 .d.ts 文件需在 jsconfig.json"include" 中)。

Meituan CatPaw
Meituan CatPaw

美团推出的智能AI编程Agent

下载

避免常见干扰项

有些写法看似合理,实则无法触发提示:

  • 漏写 /** */ 的闭合斜杠,或混用 /* ... */ 普通注释
  • 在箭头函数表达式上直接写 JSDoc(不支持),应写在变量声明前:/** @type {function(number): string} */ const fn = x => String(x);
  • 使用未定义的类型名(如 @type {Foo} 但没 @typedefimport),提示会退化为 any
  • VSCode 启用了第三方 JS 插件(如某些 Babel 插件)干扰了原生语言服务,建议关闭非必要插件测试

基本上就这些。JSDoc 提示不依赖额外插件,靠的是 VSCode 内置的 TS Server + 规范注释 + 正确配置。写得准,提示就稳。

相关专题

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

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

559

2023.06.20

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

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

437

2023.07.04

js四舍五入
js四舍五入

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

776

2023.07.04

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

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

479

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

554

2023.09.04

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

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

1091

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

659

2023.09.12

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

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

554

2023.09.20

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

58

2026.01.23

热门下载

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

精品课程

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

共58课时 | 4.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3万人学习

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

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