VSCode插件开发中代码注释自动生成规则的配置逻辑

夏杰同学_7985

夏杰同学_7985

2026-09-20

920人浏览

原创

vscode插件命令无响应的主因是activationevents未配置或不匹配,导致插件未激活;命令id须与package.json中contributes.commands的command值完全一致,且必须同时声明于activationevents中。

vscode插件开发中代码注释自动生成规则的配置逻辑

插件配置必须绑定激活事件,否则注释命令不会加载

VSCode 插件不是装上就生效的,activationEvents 决定它何时被拉起。如果你写了生成注释的命令但按快捷键没反应,大概率是这里漏配了。

常见错误:只在 contributes.commands 里注册了 comment-generator.generate,却没在 activationEvents 中声明触发条件。

  • 推荐写法:"onCommand:comment-generator.generate" —— 用户执行该命令时才激活插件,轻量且安全
  • 避免写 "*""onStartupFinished",会导致插件一开就加载,拖慢启动速度
  • 若想支持光标停在函数上自动提示,还需加 "onLanguage:javascript" 等语言钩子,否则 JS 文件里也触发不了

注释模板不能硬编码中文字段名,得靠变量替换

直接在模板字符串里写 "@description 功能说明" 看似省事,但插件运行时无法识别这是要填充的内容——它只会原样输出,不会把“功能说明”替换成用户输入或 AST 分析出的实际描述。

真正有效的做法是用插件约定的变量语法,比如 $description$$params$$returns$,再在逻辑层解析上下文后赋值。

  • koroFileHeader$description$,你得在 fileheader.customMade 里配好默认值,或在生成时弹窗让用户填
  • 自己开发插件时,要用 vscode.window.showInputBox 拿用户输入,或调 vscode.languages.getFoldingRanges + AST 解析函数签名来推导 $params$
  • 别用 ${description}(ES6 模板字面量语法),VSCode 插件模板引擎不认这个,会直接报错或静默失败

AST 解析比正则可靠,但必须等语言服务就绪

想让注释准确反映参数类型和修饰符(比如跳过 @Transient 字段、识别 readonly),就不能只靠正则匹配函数行——它会把字符串里的 id、注释里的伪代码甚至匿名类里的同名变量全抓进来。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

正确路径是走 Language Server Protocol(LSP)接口,但有个关键前提:语言服务得先 ready。

  • vscode.languages.getHovervscode.languages.getDocumentSymbol 前,务必检查 vscode.languages.hasProvider 返回 true
  • Java 场景下,等 textDocument/documentSymbol 响应后再取字段列表;TS/JS 则依赖 TypeScript Server 的 getSignatureHelpItems
  • 如果语言服务未加载(比如刚打开一个 .ts 文件,TS 插件还在初始化),强行调 API 会返回空数组或抛错,此时应降级为简单正则提取函数名+括号内容

多语言模板不能共用一套逻辑,必须按 languageId 分支处理

同一个 generateComment 命令,在 Python、C++、TypeScript 里要生成的注释格式完全不同:Python 要 """ + Google 风格,C++ 要 /** @param[in] x */,TS 则倾向 /** @param x - 描述 */。硬写一个通用模板只会哪边都不像。

最稳妥的做法是在插件主逻辑里根据 document.languageId 分发处理函数。

  • Python:调 python.docstringGenerator.style 设置读取用户偏好(google/numpy),再按规则拼 @param@return
  • C++:用 doxdocgen.c.functionTemplate 配置项获取用户定义的 Doxygen 模板,而不是自己硬编码 @brief 位置
  • TypeScript:优先复用 VSCode 内置的 JSDoc 补全逻辑(typescript.languageServiceHost.getScriptSnapshot),比自己解析 AST 更稳

最容易被忽略的是:不同语言的“函数定义行”判定规则不同。Python 看 def,TS 看 functionconst xxx = (,而 C++ 还得分清成员函数和自由函数——这些细节不拆开处理,生成的注释大概率挂错位置。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1135

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

2232

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1789

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1587

8

vscode可以写什么语言
vscode可以写什么语言

vscode是一款强大的代码编辑器,支持多种编程语言的开发。通过安装扩展,可以为 JavaScript/TypeScript、Python、Java、C#、PHP、Go、Ruby、Rust、HTML/CSS 等语言提供智能代码补全、调试和格式化等功能。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

2467

12

vscode中文设置方法
vscode中文设置方法

方法一:在设置页面中,搜索“locale”,并选择“zh-cn”。方法二:按“Ctrl Shift P”快捷键,输入“Configure Display Language”,将语言修改为“zh-cn”。如果上述方法无效,可考虑安装中文插件。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1738

14

vscode用途介绍
vscode用途介绍

Visual Studio Code(VSCode)是一款由 Microsoft 开发的多功能文本编辑器,适用于各种编程语言。作为一款开源软件,VSCode 拥有代码高亮、自动补全、调试、Git 集成等强大功能,成为程序员不可或缺的工具。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1202

10

vscode和visualstudio的区别
vscode和visualstudio的区别

Visual Studio是一款功能强大的集成开发环境(IDE),适用于专业开发人员进行复杂项目的构建。而VSCode则是一款轻量级的代码编辑器,更适合各种规模的项目开发。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

1076

8

vscode设置中文界面不生效解决方法
vscode设置中文界面不生效解决方法

vscode设置中文界面不生效解决方法:安装中文语言包、通过命令面板设置语言、检查 locale.json 设置、重新安装中文语言包、检查 VSCode 版本和更新、排除插件冲突、检查系统语言设置、查看 VSCode 日志和错误消息、重置 VSCode 设置、查看官方文档和社区支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.15

394

5

热门下载

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

精品课程

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