讲师中心 微信公众号
AI工具推荐 视频效率加速

怎么用VSCode生成代码注释文档_VSCode JSDoc自动生成与文档注释插件

浅杰小哥_6474

浅杰小哥_6474

发布时间:2026-06-11 14:39:35

|

810人浏览过

|

来源于php中文网

原创

VSCode不生成文档,仅支持JSDoc注释编写;jsdoc/typedoc工具导出HTML/Markdown。/**回车只生成空框架,因原生功能仅做基础补全,参数填充依赖语言服务对函数签名的静态解析。

怎么用vscode生成代码注释文档_vscode jsdoc自动生成与文档注释插件

VSCode 本身不生成文档,只负责写对 JSDoc 注释;真正能导出 HTML 或 Markdown 的是 jsdoc 或 typedoc 命令行工具。所谓“自动生成注释”,其实是语法结构填充,不是理解业务逻辑——函数改了但注释没同步,工具就完全失效。

为什么 /** 回车只生成空框架?

VSCode 原生的 /** + 回车只做最基础的块注释补全,参数和返回值填充依赖语言服务能否静态解析函数签名。常见失败原因:

  • 右下角语言模式不是 JavaScript 或 TypeScript(比如显示 Plain Text)
  • 函数用了箭头函数赋值式:const fn = ({id}) => {} → 解构参数无法识别
  • 项目根目录缺少 jsconfig.json,或里面没开 "checkJs": true
  • 函数体为空、只有 return、或定义后隔了空行,语言服务直接跳过

Document This 插件触发失败的典型场景

它不靠 /** 输入触发,而是依赖光标位置和 AST 结构,以下情况必然静默失败:

  • 光标停在 class X { m = () => {} } 的箭头函数内部 → 不识别为可注释函数
  • Vue <script setup></script> 中光标在 defineProps 或 useXXX 行 → 没有标准函数声明节点
  • 函数名前有 export、async、function* 等修饰符,且光标没落在 function 关键字或函数名上
  • 快捷键被系统输入法占用(如 macOS 的 Ctrl+Alt+D),需进 Keyboard Shortcuts 重映射

真正可控的三步工作流

放弃全自动幻想,用内置命令打底 + 手动校验 + CLI 验证:

Node.js 可靠编程
Node.js 可靠编程

Node.js 可靠编程技能。避免事件循环阻塞、异步陷阱、ESM 兼容问题和内存泄漏。触发词:Node.js 开发、async/await、流处理、性能优化、安全编码。

下载
  • 写完函数后,光标停在函数名上,按 Ctrl+Shift+P → 输入 Insert JSDoc comment(VS Code 内置,无需插件)→ 得到干净骨架
  • 手动补全:@param {string} [email](注意可选参数加方括号)、@returns {Promise<user>}</user>(泛型写全)、解构字段拆成独立 @param
  • 运行 jsdoc -r ./src -d ./docs --verbose → 控制台会明确告诉你哪些函数因缺 @returns 或格式错误被跳过

JSDoc 注释必须紧贴函数声明上方,中间不能有空行

这是最常被忽略的硬性规则。哪怕只多一个换行,VSCode 悬停提示、Document This 参数提取、jsdoc CLI 文档导出,全部失效。错误示例:

/** 
 * @param {string} name 
 */ 
<p>function greet(name) { }

正确写法是:

/** 
 * @param {string} name 
 */
function greet(name) { }

类型拼写也一样:写成 {numberr} 或 {Stirng},悬停提示就断了;写成 {*},连基础补全都变弱。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
js正则表达式
js正则表达式

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

4776

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1415

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1858

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

10323

2023.08.17

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

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

1020

2023.09.01

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

3004

2023.09.04

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

1629

2023.09.14

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

5169

2023.09.21

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn