0

0

在VSCode中配置和使用JSDoc来自动增强JavaScript代码提示

P粉986688829

P粉986688829

发布时间:2025-12-23 04:07:23

|

103人浏览过

|

来源于php中文网

原创

VSCode 中配置 JSDoc 的核心是正确书写标准 JSDoc 注释并启用 TypeScript 类型推导:需确保 jsconfig.json/tsconfig.json 中 "checkJs": true,删除 // @ts-nocheck,使用 /* / 格式紧贴函数/变量声明,支持 @param、@returns、@type、@typedef 等标签,可手动补全第三方库类型,排查提示失效需检查文件后缀、导出标注及语言服务状态。

在vscode中配置和使用jsdoc来自动增强javascript代码提示

在 VSCode 中配置 JSDoc 并不是为了“安装插件”,而是正确书写注释 + 启用 TypeScript 的类型推导能力——VSCode 内置的 JavaScript 支持(基于 TypeScript 语言服务)会自动解析 JSDoc 并生成精准的代码提示。

确保 JS 项目启用类型检查

VSCode 默认对 .js 文件启用轻量级类型检查,但需确认以下两点:

  • 项目根目录存在 jsconfig.json(纯 JS 项目)或 tsconfig.json(TS/JS 混合),且其中 "checkJs": true 已开启(jsconfig 示例):
{ "compilerOptions": { "target": "ES2020", "module": "commonjs", "checkJs": true, "allowJs": true, "skipLibCheck": true, "noEmit": true }, "include": ["**/*.js"], "exclude": ["node_modules"] }
  • 文件顶部没有 // @ts-nocheck 这类禁用注释;如有,删掉或改为 // @ts-check(显式启用)

写对 JSDoc 注释格式才能被识别

VSCode 不解析任意中文注释,只识别标准 JSDoc 标签 + 类型语法。关键写法:

  • /** */(双星号开头),不是 /* *///
  • 函数前紧贴声明,空行会断开关联:
/** * 计算两个数的和 * @param {number} a 第一个加数 * @param {number} b 第二个加数 * @returns {number} 和 */ function add(a, b) { return a + b; }
  • 支持复杂类型:用 @type 给变量/属性标注,例如:
    /** @type {Map} */
    const userMap = new Map();
  • 支持 @typedef 定义自定义类型别名,后续可复用:
/** * @typedef {Object} User * @property {number} id * @property {string} name * @property {string} [email] 可选字段 */

/* @type {User[]} / const users = [];

利用 JSDoc 补齐第三方库缺失类型

很多纯 JS 库(如 Lodash、Axios)不自带类型定义,但你可以用 JSDoc “手动补全”:

Hitems
Hitems

HITEMS是一个AI驱动的创意设计平台,支持一键生成产品

下载

立即学习Java免费学习笔记(深入)”;

  • 给导入对象加 @type
/** @type {import('axios').AxiosInstance} */
const api = axios.create({ baseURL: '/api' });
  • 为无类型模块新建 types.d.js(同目录),写 @typedef + export 声明,VSCode 会自动加载

提示不生效?快速排查这几点

如果写了 JSDoc 却没提示,大概率是以下原因:

  • 文件后缀是 .mjs.cjs?VSCode 当前对这类扩展名的 JS 支持不稳定,建议暂用 .js
  • JS 文件里用了 export default 但没写 /** @type {...} */?默认导出需显式标注类型才提示准确
  • VSCode 状态栏右下角显示 “JavaScript” 而非 “TypeScript”?点击切换为 TypeScript 引擎(会强制启用类型检查)
  • 重启 VSCode 或按 Ctrl+Shift+P → “Developer: Restart TS Server” 刷新语言服务

基本上就这些。不需要额外插件,也不用编译,写对注释 + 开启 checkJs,VSCode 就能实时给出接近 TypeScript 的智能提示。

热门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语言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

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

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

1

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号