0

0

VSCode中的JSDoc注释与智能提示

P粉986688829

P粉986688829

发布时间:2025-12-22 15:19:02

|

574人浏览过

|

来源于php中文网

原创

VSCode 对 JSDoc 支持扎实,规范书写即可触发类型提示、参数说明和自动补全;需用 /* / 紧贴声明上方,正确使用 @param、@returns、@type 等标签,并配合 jsconfig.json 或 tsconfig.json 配置以确保最佳效果。

vscode中的jsdoc注释与智能提示

VSCode 对 JSDoc 的支持很扎实,只要写法规范,就能直接触发类型提示、参数说明和自动补全,不用装额外插件(TypeScript 项目或启用了 JS 语言服务时效果最佳)。

基础写法决定提示是否出现

JSDoc 注释必须紧贴函数、变量或类的上方,且用 /** */ 包裹(不是 /* *///)。光标停在函数名或调用处时,Hover 就能显示文档内容。

  • ✅ 正确:
    /**
    * 计算两个数的和
    * @param {number} a 第一个数
    * @param {number} b 第二个数
    * @returns {number}
    */
    function add(a, b) { return a + b; }
  • ❌ 无效:注释和函数之间有空行、用了单行注释、或者 JSDoc 没闭合

@param 和 @returns 类型要写对

VSCode 不做类型校验,但会按你写的类型文本去匹配已知类型(如 stringnumberPromise),甚至支持泛型和交叉类型。写错类型名(比如拼成 numberr)会导致提示不准确或消失。

  • 推荐用标准类型: @param {Array} names@param {import('./types').User} user
  • 对象参数可用 @param {{ id: number; name: string }} opts 直接内联定义
  • 返回 Promise 时写 @returns {Promise},调用处 `.then()` 的参数就能获得 string 提示

利用 @type 给变量加类型提示

普通 JS 变量默认无类型推导,但加上 @type 就能激活智能提示。适合配置对象、回调函数、第三方库返回值等场景。

神卷标书
神卷标书

神卷标书,专注于AI智能标书制作、管理与咨询服务,提供高效、专业的招投标解决方案。支持一站式标书生成、模板下载,助力企业轻松投标,提升中标率。

下载
  • /** @type {HTMLButtonElement} */
    const btn = document.querySelector('button'); → 后续访问 btn.click() 就有完整方法提示
  • /** @type {(id: string) => Promise} */
    const fetchUser = async (id) => { ... };
  • 配合 @typedef 可定义复用类型:/** @typedef {{ name: string; age: number }} Person */

小技巧让提示更准更稳

有些情况提示“失灵”,往往不是 VSCode 问题,而是上下文没对上。

  • 确保文件是 .js.mjs,且没有被 // @ts-nocheck 禁用 JS 语言服务
  • 大型项目建议配 jsconfig.json(JS)或 tsconfig.json(TS),开启 "checkJs": true"allowJs": true
  • VSCode 设置里确认 JavaScript > Suggest: Auto Imports 是开启状态,这样从 JSDoc 推导出的类型也能参与自动导入

基本上就这些。写得规范,VSCode 就能“读懂”你的 JSDoc,并把提示自然地送过来——不复杂但容易忽略细节。

热门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中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

443

2023.08.02

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

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

531

2023.09.20

typedef和define区别
typedef和define区别

typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

109

2023.09.26

c语言typedef的用法
c语言typedef的用法

c语言typedef的用法有定义基本类型别名、定义结构体别名、定义指针类型别名、定义枚举类型别名、定义数组类型别名等。本专题为大家提供typedef相关的文章、下载、课程内容,供大家免费下载体验。

98

2023.09.26

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

158

2026.01.28

热门下载

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

精品课程

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

共46课时 | 3万人学习

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

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