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

在 VSCode 中配置 JSDoc 并不是为了“安装插件”,而是正确书写注释 + 启用 TypeScript 的类型推导能力——VSCode 内置的 JavaScript 支持(基于 TypeScript 语言服务)会自动解析 JSDoc 并生成精准的代码提示。
VSCode 默认对 .js 文件启用轻量级类型检查,但需确认以下两点:
jsconfig.json(纯 JS 项目)或 tsconfig.json(TS/JS 混合),且其中 "checkJs": true 已开启(jsconfig 示例):// @ts-nocheck 这类禁用注释;如有,删掉或改为 // @ts-check(显式启用)VSCode 不解析任意中文注释,只识别标准 JSDoc 标签 + 类型语法。关键写法:
/** */(双星号开头),不是 /* */ 或 //
@type 给变量/属性标注,例如:@typedef 定义自定义类型别名,后续可复用:/* @type {User[]} / const users = [];
很多纯 JS 库(如 Lodash、Axios)不自带类型定义,但你可以用 JSDoc “手动补全”:
立即学习“Java免费学习笔记(深入)”;
@type:types.d.js(同目录),写 @typedef + export 声明,VSCode 会自动加载如果写了 JSDoc 却没提示,大概率是以下原因:
.mjs 或 .cjs?VSCode 当前对这类扩展名的 JS 支持不稳定,建议暂用 .js
export default 但没写 /** @type {...} */?默认导出需显式标注类型才提示准确Ctrl+Shift+P → “Developer: Restart TS Server” 刷新语言服务基本上就这些。不需要额外插件,也不用编译,写对注释 + 开启 checkJs,VSCode 就能实时给出接近 TypeScript 的智能提示。
以上就是在VSCode中配置和使用JSDoc来自动增强JavaScript代码提示的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号