vscode自动添加文件和函数注释

自动添加注释

Doxygen Documentation Generator

此插件是vscode自动注释添加的插件,首先需要在vscode中查找并安装插件。如下图所示,插件在未安装的情况下会显示蓝色的Install样式,直接点击即可自动安装,已安装的情况下会显示设置图标。

配置

根据下图标注进入配置页面。

配置选项介绍

C:Comment PreFix : 表示除了注释第一行和最后一行其他注释行的前缀

C:First Line:表示注释第一行显示的内容

C:Last Line:表示注释最后一行显示的内容

C:Trigger Sequence:设置触发注释的方式,类似于快捷键,输入字符序列然后回车即可自动填充注释信息

Cpp:Tparam Tempate:表示函数参数注释

File:Copyright Tag:表示填充的版权信息,需要在settings.json中进行配置

File:File Order :用于对文件头注释信息排序,即按照规定的顺序对各注释字段排序

File:File Template:文件名称注释,@file {name},表示会生成注释行@file name会被文件名称替换

File:Version Tag:文件版本信息注释,@version 0.1,则自动生成的文件头注释会有此信息行

Generic:Author Email:使用到邮箱信息时,会以此处的邮箱进行自动填充

Generic:Author Name:使用到用户名信息时,会以此处的信息进行自动填充

Generic:Author Tag:用户名注释行会以此处设置的格式进行填充

Generic:Brief Template:表示要填充的说明信息

Generic:Custom Tags:表示用户自定义信息,需要在settings.json中配置保存

Generic:Date Format:设置要显示的日期格式

Generic:Date Template:设置日期注释行,日期格式按上述设置的格式显示

Generic:Order:设置函数注释各字段的排列顺序

Generic: Param Template:设置函数参数注释行格式,可自动罗列函数参数信息

Generic: Return Template:设置函数返回值注释行的格式

配置文件头注释

自动生成文件头信息如下所示:

配置函数头注释

自动生成的函数头信息如下所示:

相关推荐
乐闻x6 分钟前
VSCode 插件开发实战(九): 不同插件之间如何通信
ide·vscode·编辑器
奋斗吧程序媛8 分钟前
删除VSCode上 origin/分支名,但GitLab上实际上不存在的分支
前端·vscode
乐闻x10 分钟前
VSCode 插件开发实战(十): 环境变量Env设置与管理
ide·vscode·编辑器
jieshenai31 分钟前
使用 VSCode 学习与实践 LaTeX:从插件安装到排版技巧
ide·vscode·学习
机器懒得学习33 分钟前
打造高效的 LaTeX 公式编辑器
编辑器
叶羽西15 小时前
Android Studio打开一个外部的Android app程序
android·ide·android studio
向宇it20 小时前
【从零开始入门unity游戏开发之——unity篇02】unity6基础入门——软件下载安装、Unity Hub配置、安装unity编辑器、许可证管理
开发语言·unity·c#·编辑器·游戏引擎
徐小夕@趣谈前端20 小时前
可视化大屏编辑器, 开源!
编辑器
天天进步201520 小时前
TipTap编辑器:现代化的富文本编辑解决方案
编辑器
odng1 天前
IDEA自己常用的几个快捷方式(自己的习惯)
java·ide·intellij-idea