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

VSCode配置JSDoc插件实现自动化方法参数注释模板

落杰酱_9486

落杰酱_9486

发布时间:2026-09-01 06:47:26

|

871人浏览过

|

来源于php中文网

原创

VSCode原生JSDoc需满足三点:语言模式为JS/TS、光标在函数声明正上方空行、函数有明确参数名;Document This不支持解构和箭头函数;koroFileHeader需手动填类型;推荐用代码片段jsdoc实现轻量可控。

vscode配置jsdoc插件实现自动化方法参数注释模板

VSCode 本身不依赖插件就能生成基础 JSDoc 参数注释,但“自动化”程度取决于你用的是原生功能、Document This 还是 koroFileHeader——三者触发逻辑、支持语法、变量写法完全不同,混用必冲突。

为什么 /** 回车没生成 @param?检查这三点

这不是插件失效,而是 VSCode 原生 JSDoc 模板生成有硬性前提:

  • 当前文件右下角语言模式必须是 javascript 或 typescript(不能是 Plain Text)
  • 光标必须落在函数声明行正上方的空行(如 function foo(a, b) { 的上一行),不能在函数体内或已有注释中
  • 函数必须有明确参数名(function bar({ id, name }) 或 const fn = (a) => {} 都不被识别)

Document This 插件:适合带类型签名的函数,但不认解构和箭头表达式

它基于 AST 推导 @param 类型,比原生更准,但只对“标准函数声明”和“有 TS/JSDoc 类型标注”的场景可靠:

  • ✅ 支持:function fetchUser(id: string): Promise<user></user> → 自动补 @param {string} id 和 @returns {Promise<User>}
  • ❌ 不支持:const handler = ({ userId, role }) => {}(解构参数全丢);const fn = () => 42(箭头函数表达式体不触发)
  • ⚠️ 注意:document-this.insertDescription 默认为 false,会导致 @description 空着,建议设为 true

koroFileHeader:稳定跨语言,但 @param 类型要手动填

它不解析 JS 类型,只做纯文本模板填充,所以不会因语法新特性崩,但也不会自动推导 @param {string} 这类类型:

Comprehensive Three.js 3D graphics reference
Comprehensive Three.js 3D graphics reference

详细的 Three.js 3D 图形参考,涵盖场景设置、相机、几何体、材质、光照、动画、控制器、加载器、数学工具和调试。

下载
  • 模板里写 * @param {string} $1 - $2,它就照搬,$1/$2 是光标占位符,不是自动识别的参数名
  • 快捷键 Ctrl+Alt+T(Win)触发后,光标停在第一个 $1,你得自己输参数名,再 Tab 到 $2 写描述
  • 好处是:支持中文变量名(如 @param {number} 用户ID)、支持 $date$ 自动更新时间、不依赖语言服务,JS/TS/Python 全通用

用户代码片段(Snippets):最轻量可控,推荐用于高频函数模板

用 javascript.json 配一个简短 prefix,比如 jsdoc,避免和插件快捷键打架:

{
  "JSDoc Function": {
    "prefix": "jsdoc",
    "body": [
      "/**",
      " * @description ${1:功能说明}",
      " * @param {${2:any}} ${3:paramName} - ${4:参数描述}",
      " * @returns {${5:any}} ${6:返回说明}",
      " */"
    ],
    "description": "手动可控的 JSDoc 函数模板"
  }
}

这样输入 jsdoc + Tab,光标依次停在描述、类型、参数名、参数描述等位置,填完即用。不用装插件,不随插件更新变行为,也绕开了 Document This 对解构/箭头函数的识别缺陷。

真正难的不是生成注释,而是让 @param 类型写得准、跟函数实现一致——所有插件都做不到这点,最终还得人看一眼函数体再敲一次键盘。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

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

豆包大模型

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

DeepSeek

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

相关专题

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

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

3896

2023.06.20

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

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

1235

2023.07.28

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

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

1578

2023.08.03

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

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

9363

2023.08.17

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

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

860

2023.09.01

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

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

2324

2023.09.04

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

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

1449

2023.09.14

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

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

3909

2023.09.21

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

0

2026.09.30

热门下载

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

精品课程

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

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