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

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

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

537

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

372

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

727

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

389

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

989

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

652

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

537

2023.09.20

ip地址修改教程大全
ip地址修改教程大全

本专题整合了ip地址修改教程大全,阅读下面的文章自行寻找合适的解决教程。

27

2025.12.26

热门下载

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

精品课程

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

共48课时 | 6.1万人学习

Git 教程
Git 教程

共21课时 | 2.2万人学习

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

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