VSCode中实现JSDoc自动生成与提示需四步:一、创建jsconfig.json启用内置语言服务;二、安装Document This插件并配置返回类型;三、通过Emmet配置jsdoc代码片段;四、更新TypeScript至4.9+并启用TSDoc验证与悬停提示。

如果您在使用 VSCode 编写 JavaScript 或 TypeScript 代码时希望快速生成标准化的 JSDoc 注释并获得实时参数提示,则可能是由于未正确配置语言服务或缺少相关扩展支持。以下是实现 JSDoc 注释自动生成与提示的具体操作步骤:
本文运行环境:MacBook Air M2,macOS Sequoia。
一、启用内置 JavaScript/TypeScript 语言功能
VSCode 自带的 TypeScript 语言服务已深度集成 JSDoc 支持,无需额外安装插件即可实现基础注释提示与类型推导。该功能依赖于项目中存在有效的 tsconfig.json 或 jsconfig.json 配置文件以激活语义检查。
1、在项目根目录下创建 jsconfig.json 文件(适用于纯 JavaScript 项目)。
2、向文件中写入以下内容:{"compilerOptions": {"checkJs": true, "allowJs": true, "maxNodeModuleJsDepth": 2}}。
3、保存文件后,重启 VSCode 窗口或执行命令面板中的 Developer: Reload Window。
二、安装 Prettier + JSDoc 插件组合
通过扩展增强 JSDoc 的格式化能力与快捷生成效率,可显著提升注释编写速度与一致性。此方案不依赖 TypeScript 编译器,适用于所有 JS 文件。
1、打开 VSCode 扩展市场,搜索并安装 Document This(作者:joelday)。
2、安装完成后,在任意函数定义行上方输入 /** 并按 Enter 键,自动插入完整 JSDoc 模板。
3、在设置中搜索 documentthis,将 Document This: Include Return Type 设为 true。
三、配置 Emmet 快速触发 JSDoc 片段
Emmet 内置支持自定义代码片段,可通过简短缩写快速展开标准 JSDoc 结构,适用于无鼠标操作场景及高频注释需求。
1、按下 Cmd+Shift+P(Mac)或 Ctrl+Shift+P(Windows/Linux),输入 Preferences: Configure User Snippets 并回车。
采用三层架构开发,前台集成了产品在线展示,用户注册、在线调查、在线投稿后台有类别管理\图书管理\订单管理\会员管理\配送范围管理\邮件列表\广告管理\友情链接管理等后台添加图书时自动生成缩略图和文字水印主要参考了petshop的设计架构、使用了Asp.net2.0中很多MemberShip、master等新功能后台管理地址/web/admin/ 超级管理员账号密码均为aspx1特别提示:该系统需要
2、选择 javascript.json(若不存在则新建)。
3、在 snippets 对象内添加如下条目:"jsdoc": {"prefix": "jsdoc","body": ["/**"," * @param {${1:type}} ${2:name}"," * @returns {${3:type}}"," */"],"description": "JSDoc comment"}。
四、启用 TSDoc 验证与悬停提示
TSDoc 是微软维护的 JSDoc 兼容规范,VSCode 在识别符合 TSDoc 格式的注释后,可在函数调用处显示参数名、类型与描述信息。该功能需确保 TypeScript 版本不低于 4.9。
1、在项目中运行 npm install -D typescript 更新本地 TypeScript 依赖。
2、在函数上方编写如下结构的注释:/** @param {string} name 用户姓名 */。
3、将光标悬停于该函数调用位置,确认出现含参数说明的智能提示框。
五、调整 JavaScript 语言模式为严格检查模式
默认情况下,VSCode 对 .js 文件采用宽松语法检查。切换为严格模式后,JSDoc 中声明的类型将参与运行前校验,并强化参数提示准确性。
1、在任意 .js 文件中右下角点击当前语言模式标识(如 “JavaScript”)。
2、选择 Configure File Association for '.js',然后选中 JavaScript React。
3、在设置中搜索 javascript.preferences.includePackageJsonAutoImports,设为 off 以减少干扰提示。









