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)。

MusicLM
MusicLM

谷歌平台的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"]。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

50

2026.02.13

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

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

199

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

91

2026.03.13

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

83

2025.09.10

es6新特性
es6新特性

es6新特性有:1、块级作用域变量;2、箭头函数;3、模板字符串;4、解构赋值;5、默认参数;6、 扩展运算符;7、 类和继承;8、Promise。本专题为大家提供es6新特性的相关的文章、下载、课程内容,供大家免费下载体验。

106

2023.07.17

C++多线程并发控制与线程安全设计实践
C++多线程并发控制与线程安全设计实践

本专题围绕 C++ 在高性能系统开发中的并发控制技术展开,系统讲解多线程编程模型与线程安全设计方法。内容包括互斥锁、读写锁、条件变量、原子操作以及线程池实现机制,同时结合实际案例分析并发竞争、死锁避免与性能优化策略。通过实践讲解,帮助开发者掌握构建稳定高效并发系统的关键技术。

2

2026.03.16

热门下载

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

精品课程

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

共14课时 | 0.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

CSS教程
CSS教程

共754课时 | 43.7万人学习

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

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