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

VSCode插件实现js代码自定义注释模板

星婷君_6420

星婷君_6420

发布时间:2026-08-16 11:09:24

|

537人浏览过

|

来源于php中文网

原创

VSCode原生Snippets可配置轻量JS注释模板,koroFileHeader支持自动更新,Document This提供类型推断;三者应职责分离,避免混用导致冲突。

vscode插件实现js代码自定义注释模板

用用户代码片段(Snippets)配置 JS 注释模板

VSCode 原生支持通过 javascript.json 用户代码片段实现轻量、稳定、无依赖的 JS 注释模板,比插件更可控,也避免了插件更新导致行为突变的问题。关键在于模板写对、变量用准、触发及时。

  • prefix 要简短易记,比如 fn 用于函数注释、hdr 用于文件头,输入后按 Tab 即可展开
  • body 中每行必须是字符串数组元素,换行靠新增数组项,不能用 \n
  • 动态变量如 ${CURRENT_YEAR}、${TM_FILENAME_BASE}、${TM_CURRENT_LINE} 会实时计算,但 ${TM_CURRENT_LINE} 在函数定义行上方触发时可能为空,建议改用光标位置占位符 ${1:funcName}
  • 作者名需提前在 VSCode 设置中配置 editor.userAuthor(或通过 settings.json 手动加 "editor.userAuthor": "Your Name"),否则 ${TM_AUTHOR} 不生效

用 koroFileHeader 插件生成带自动更新的函数/文件注释

如果你需要「保存即更新最后编辑时间」或「跨语言统一模板」,koroFileHeader 是目前最成熟的方案。它不依赖语言服务,纯文本解析,对 JS/TS/Python/Go 等都稳定有效。

Feishu calendar sync, local ics to json data for AI agent
Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式,用于飞书日历导入导出及数据集成。

下载
  • 快捷键:文件头用 Ctrl+Alt+I(Win/Linux)或 Cmd+Alt+I(macOS);函数注释用 Ctrl+Alt+T / Cmd+Alt+T
  • 模板变量用 $date$、$author$、$description$,不是 ${...} 格式,写错就无法替换
  • 启用自动更新需在 settings.json 中设:"fileheader.configObj": { "autoAdd": true, "autoUpdate": true } —— 注意不是 autoupdate(常见拼写错误)
  • 函数注释默认不识别参数类型,若需 @param {string} name 这类标注,得配合 Document This 或手动补全,koroFileHeader 本身不解析 JS 类型

Document This 插件生成带类型推断的 JSDoc 注释

当你写的是带明确签名的函数(尤其有 TypeScript 类型或 JSDoc 已有部分标注),Document This 能基于 AST 推导 @param 和 @returns 类型,比纯模板更智能。

  • 触发方式不止快捷键:/** + Enter、右键菜单、命令面板输入 Document This 都可
  • 默认不填 @description,容易留空;可在设置中开启 "document-this.insertDescription": true 强制生成
  • 对箭头函数、匿名函数、方法简写(如 method() {})支持不稳定,光标必须严格落在函数名上,而非括号或花括号内
  • 若项目没配 jsconfig.json 或 tsconfig.json,类型推断会退化为 {any},此时不如用 Snippets 手动写准类型

为什么不要混用多个注释插件

多个插件监听同一事件(如 /** 回车)会导致冲突:一个插件生成了模板,另一个又覆盖重写,或者快捷键被劫持,最终注释格式错乱、光标跳转异常、甚至卡死。

  • 推荐组合:Snippets(基础模板) + koroFileHeader(文件/函数头自动更新)——二者职责分明,无重叠逻辑
  • 禁用冲突项:装了 Document This 后,关掉 VSCode 内置的 jsdoc.autoAppendClosingTag,否则末尾 */ 可能被重复添加
  • 真实坑点:某些团队规范要求 @since 字段带版本号,但所有插件都不支持自动读取 package.json 的 version,只能靠 Snippets + 自定义脚本或 CI 检查兜底

热门AI工具

更多
超级简历WonderCV

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

豆包大模型

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

DeepSeek

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

WorkBuddy

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

火山引擎

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

Laper
Laper Hot

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

相关专题

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

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

4016

2023.06.20

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

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

1275

2023.07.28

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

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

1618

2023.08.03

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

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

9523

2023.08.17

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

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

900

2023.09.01

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

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

2424

2023.09.04

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

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

1489

2023.09.14

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

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

4109

2023.09.21

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

vscode手册
vscode手册

共0课时 | 0人学习

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

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