0

0

VSCode中的JSDoc:为你的JS代码自动生成文档注释

P粉986688829

P粉986688829

发布时间:2026-01-01 04:17:36

|

254人浏览过

|

来源于php中文网

原创

VSCode中可自动补全JSDoc注释:一、用/**回车生成基础模板;二、装Auto Import扩展提升类型推断;三、启用jsdoc.autoAppendClosingTag和formatOnSave确保格式规范;四、用JavaScript Docstring Generator自定义模板。

如果您在vscode中编写javascript代码,希望快速为函数、类或变量添加标准化的jsdoc注释,但手动编写耗时且易出错,则可借助编辑器内置功能与扩展实现自动化补全。以下是实现jsdoc注释自动生成的具体步骤:

本文运行环境:MacBook Air,macOS Sequoia。

一、使用VSCode内置JSDoc快捷键

VSCode原生支持JSDoc模板生成,无需安装额外扩展,适用于函数声明、方法定义等常见场景,其原理是根据光标所在位置的函数签名自动推导参数与返回值类型。

1、将光标置于函数名正上方空行处(如function calculateTotal() { 的上一行)。

2、输入 /** 并按下回车键。

3、VSCode自动展开为完整JSDoc结构,包含 @param 和 @returns 占位符,并依据函数参数列表填充参数名。

二、安装并配置Auto Import扩展增强识别

当项目中存在类型定义文件(如.d.ts)或ES6模块导入时,基础快捷键可能无法准确识别参数类型。Auto Import扩展能结合TypeScript语言服务,提升JSDoc中@param类型推断的准确性。

1、打开VSCode扩展面板(Ctrl+Shift+X 或 Cmd+Shift+X)。

2、搜索并安装 Auto Import - ES6, TS, JSX, CSS, JSON 扩展。

3、重启VSCode后,在函数上方输入 /** 回车,观察是否自动补全更精确的类型标注(如 @param {number} count)。

Moshi Chat
Moshi Chat

法国AI实验室Kyutai推出的端到端实时多模态AI语音模型,具备听、说、看的能力,不仅可以实时收听,还能进行自然对话。

下载

三、通过设置启用JSDoc自动闭合与格式化

默认情况下,VSCode不会自动闭合JSDoc块末尾的 */,也未强制对齐多行注释。启用相关设置可确保生成的注释符合团队规范,避免格式混乱。

1、进入设置界面(Cmd+, 或 Ctrl+,)。

2、搜索 jsdoc.autoAppendClosingTag,将其设为 true。

3、再搜索 editor.formatOnSave,确保该选项已启用。

四、利用JavaScript Docstring Generator扩展定制模板

对于需要统一公司级文档风格(如添加@author、@since、@example)的场景,内置功能无法满足。JavaScript Docstring Generator扩展允许用户自定义JSDoc模板,适配不同项目规范。

1、在扩展市场中安装 JavaScript Docstring Generator

2、按 Cmd+Shift+P(Mac)或 Ctrl+Shift+P(Windows/Linux),输入 Docstring: Configure Template 并回车。

3、在弹出的JSON编辑器中,修改 template 字段,例如添加 "author": "Your Name" 与 "example": ["// example usage"]。

相关专题

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

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

542

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

391

2023.09.04

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

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

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

653

2023.09.12

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

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

544

2023.09.20

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

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

共14课时 | 0.7万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.7万人学习

CSS教程
CSS教程

共754课时 | 17.3万人学习

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

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