JSDoc是VSCode中提升JavaScript协作效率和可维护性的实用工具,需用/* /紧贴函数上方书写,配合规范标签(如@param、@returns)、具体类型声明及jsconfig.json配置,才能激活智能提示、类型检查与自动补全。

在VSCode中写JavaScript时,JSDoc不是装饰,是提升协作效率和代码可维护性的实用工具。它让函数、参数、返回值一目了然,还能触发智能提示、类型检查和自动补全。
写对基础格式,VSCode立刻识别
JSDoc注释必须紧贴函数或变量上方,用/** */包裹,不能是/* */或//。VSCode靠这个约定激活文档支持。
- ✅ 正确:/** @param {string} name */
function greet(name) { ... } - ❌ 错误:/* @param {string} name */
function greet(name) { ... }(VSCode不解析) - 光标停在函数名上,悬停就能看到完整文档;调用时参数名、类型、说明自动浮现
常用标签怎么写才真正起作用
VSCode不只看标签名,更依赖语法是否规范。几个高频标签的写法要点:
-
@param:紧跟花括号写类型,空格后写参数名,再换行写说明
/** @param {number} age 用户年龄,必须大于0 */ -
@returns:类型必填,说明可选
/** @returns {boolean} 是否成年 */ -
@typedef:定义自定义类型,后续可用在@param或@returns中
/** @typedef {{id: number, name: string}} User */ - @example:加@example后换行缩进写代码,VSCode会在悬停中高亮显示示例
配合TypeScript或JSDoc类型推导,效果翻倍
即使不用TS编译,VSCode也能基于JSDoc做静态分析。关键在于类型声明要具体:
本文档主要讲述的是Android中JNI编程的那些事儿;JNI译为Java本地接口。它允许Java代码和其他语言编写的代码进行交互。在android中提供JNI的方式,让Java程序可以调用C语言程序。android中很多Java类都具有native接口,这些接口由本地实现,然后注册到系统中。希望本文档会给有需要的朋友带来帮助;感兴趣的朋友可以过来看看
立即学习“Java免费学习笔记(深入)”;
- 用{string[]}比{Array}更准,能触发数组方法提示
- 对象类型推荐用{name: string, score?: number},问号表示可选属性
- 函数类型写成{(id: string): Promise
} ,VSCode会校验调用时的参数和返回 - 开启"js/ts.implicitProjectConfig.checkJs": true(在settings.json里),让纯.js文件也启用类型检查
别忽略这些小细节,否则提示不出现
写了JSDoc却没提示?常见卡点就这几个:
- 函数被赋值给变量(如const fn = function() {}),JSDoc必须写在function关键字正上方,而不是变量声明前
- 箭头函数不支持直接写JSDoc,需改用函数声明,或在变量声明前加注释并标注@type
- 项目根目录有jsconfig.json(哪怕空文件)才能启用完整JS语言服务
- 确保VSCode没有禁用JavaScript/TypeScript语言功能(检查设置里"javascript.suggest.autoImports"等是否开启)
基本上就这些。不需要大改代码结构,从下一个函数开始补上几行JSDoc,立刻就能感受到编辑器变得更“懂你”。









