0

0

VSCode的JSDoc注释自动生成与提示

P粉986688829

P粉986688829

发布时间:2025-12-27 14:09:24

|

847人浏览过

|

来源于php中文网

原创

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

vscode的jsdoc注释自动生成与提示

如果您在使用 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 结构,适用于无鼠标操作场景及高频注释需求。

迦恩计算机资源网源码(图书销售类)
迦恩计算机资源网源码(图书销售类)

采用三层架构开发,前台集成了产品在线展示,用户注册、在线调查、在线投稿后台有类别管理\图书管理\订单管理\会员管理\配送范围管理\邮件列表\广告管理\友情链接管理等后台添加图书时自动生成缩略图和文字水印主要参考了petshop的设计架构、使用了Asp.net2.0中很多MemberShip、master等新功能后台管理地址/web/admin/ 超级管理员账号密码均为aspx1特别提示:该系统需要

下载

1、按下 Cmd+Shift+P(Mac)或 Ctrl+Shift+P(Windows/Linux),输入 Preferences: Configure User Snippets 并回车。

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 以减少干扰提示。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

43

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

116

2026.02.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

451

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

326

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

910

2023.08.02

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

530

2023.06.20

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

48

2026.02.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 10万人学习

Git 教程
Git 教程

共21课时 | 4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号