jsDoc 注释本身不自动开启智能提示,但能增强类型推导与补全——需项目配置得当、注释规范:启用 jsconfig.json/tsconfig.json 或 // @ts-check,正确书写 @type/@param/@returns/@typedef 等标签,并确保路径与类型定义可被解析。
vscode 中的 jsdoc 注释本身不会自动“开启”智能提示,但它能显著增强 typescript 和 javascript 文件中的类型推导与补全能力——前提是项目配置得当、注释写得规范。
确保启用了 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<user>} */</user>→ 函数调用时显示参数名、类型和返回值 -
/** @typedef {{id: number, name: string}} User */→ 自定义类型,后续可复用:@type {User} -
/** @extends {map<string number>} */ class MyMap extends Map {}</string>→ 继承类也能获得父类方法提示
配合类型导入提升跨文件提示
如果类型定义在其他文件中(比如 types.js 或 user.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" 中)。
避免常见干扰项
有些写法看似合理,实则无法触发提示:
- 漏写
/** */的闭合斜杠,或混用/* ... */普通注释 - 在箭头函数表达式上直接写 JSDoc(不支持),应写在变量声明前:
/** @type {function(number): string} */ const fn = x => String(x); - 使用未定义的类型名(如
@type {Foo}但没@typedef或import),提示会退化为any - VSCode 启用了第三方 JS 插件(如某些 Babel 插件)干扰了原生语言服务,建议关闭非必要插件测试
基本上就这些。JSDoc 提示不依赖额外插件,靠的是 VSCode 内置的 TS Server + 规范注释 + 正确配置。写得准,提示就稳。