VSCode添加插件实现一键注释功能

落强酱_7675

落强酱_7675

2026-09-06

523人浏览

原创

真正支持c/c++函数参数自动提取的插件只有ms-vscode的doxygen documentation generator,需重启vs code、光标紧贴函数声明正上方、配合korofileheader处理文件头,且配置必须显式指定模板和更新规则。

vscode添加插件实现一键注释功能

能直接用,但得选对插件、配对配置、避开常见失效点——否则快捷键按了没反应,或者生成的 @param 和函数参数名对不上。

装哪个插件才真正支持 C/C++ 函数参数自动提取

只认作者是 ms-vscode 的 Doxygen Documentation Generator。VS Code 插件市场里搜 “Doxygen” 会出现多个同名插件,其他版本基本靠硬编码写 @param param1,根本不会读你函数声明里的 int x, char* buf。装错后生成的注释看着整齐,但 doxygen 工具解析时直接跳过整块注释,等于白写。

  • 安装后必须重启 VS Code,否则 Ctrl+Win+T(Windows)或 Cmd+Option+T(macOS)无响应——不是快捷键冲突,是插件服务没加载
  • 光标必须紧贴函数声明正上方,中间不能有空行;否则插件无法识别上下文,生成结果为空或错误
  • 文件头注释和函数注释模板要分开配置,Doxygen Documentation Generator 不处理文件头,得另配插件(比如 koroFileHeader)

koroFileHeader 的快捷键和配置关键项

koroFileHeader 负责文件头和光标处函数注释,但默认配置容易踩坑:比如 "autoAdd": true 会导致新建文件就自动塞注释,干扰模板文件或脚本开头;又比如 "Date" 和 "LastEditTime" 都设成 "Do not edit",结果保存时时间不更新。

VSCode
VSCode

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

下载
  • 文件头快捷键:Ctrl+Alt+I(Windows)、Ctrl+Cmd+I(macOS)
  • 函数注释快捷键:Ctrl+Alt+T(Windows)、Ctrl+Cmd+T(macOS)
  • 必须在 setting.json 里显式配置 "fileheader.customMade" 和 "fileheader.cursorMode",否则用的是插件内置默认模板,字段名(如 @Author)和格式可能不符合团队规范
  • "fileheader.configObj" 中的 "writeFile": true 控制保存时是否自动更新 LastEditors 和 LastEditTime,关掉就不起作用

DocumentThis 适合 JS/TS,但触发方式很具体

DocumentThis 对 JavaScript 和 TypeScript 支持最稳,但触发依赖符号位置和输入动作,不是所有光标位置都有效。

  • 必须把光标放在函数、类或变量**正上方一行**,然后输入 /** 再按 Tab 或 Enter
  • 右键菜单调用或命令面板输入 Document This 也能触发,但不如 /** + Tab 直观可靠
  • 它会尝试推断参数类型和返回值,但遇到复杂类型(如泛型、联合类型)可能漏判或写错,需要人工核对 @param 和 @returns
  • 不支持 C/C++ 函数签名解析,强行用会把整个函数体当字符串处理,生成的注释完全不可信

真正麻烦的不是装插件,而是不同语言、不同注释用途(文件头 / 函数 / Doxygen 输出)得混搭至少两个插件,且每个插件的配置项、触发条件、失效边界都不一样——比如 koroFileHeader 的 cursorMode 不管你光标在函数体内还是函数名上,只要在“函数作用域内”就敢生成注释,而 Doxygen Documentation Generator 必须卡在声明正上方。稍不注意,就生成了一堆废注释。

相关文章

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

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

下载

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

相关专题

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

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

2023.06.30

1395

18

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

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

2023.07.21

2932

3

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

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

2024.03.14

1989

12

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

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

2024.03.14

1727

8

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

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

2024.03.15

2607

12

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

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

2024.03.15

1838

14

vscode用途介绍
vscode用途介绍

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

2024.03.15

1262

10

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

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

2024.03.15

1116

8

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

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

2024.03.15

494

5

热门下载

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

精品课程

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