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:设置函数返回值注释行的格式

配置文件头注释

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

配置函数头注释

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

相关推荐
李少兄9 小时前
解决IntelliJ IDEA 提交代码时无复选框问题
java·ide·intellij-idea
sniper_fandc10 小时前
IDEA修改系统缓存路径,防止C盘爆满
java·ide·intellij-idea
CUIYD_198911 小时前
Eclipse 常用搜索功能汇总
java·ide·eclipse
byte轻骑兵13 小时前
365 天技术创作手记:从一行代码到四万同行者的相遇
ide·vscode·编辑器
点云侠14 小时前
解决Visual Studio 2022编译工程速度慢的问题
开发语言·c++·ide·算法·计算机视觉·visual studio
奥特曼打小白15 小时前
Visual Studio Code的第一次安装
ide·vscode·编辑器
weixin_4569042715 小时前
Vscode中开发VUE项目的调试方案
ide·vue.js·vscode
小猫挖掘机(绝版)15 小时前
通过tailscale实现一台电脑上vscode通过ssh连接另一台电脑上的VMware Linux 虚拟机
linux·windows·vscode·ubuntu·ssh
和小胖112215 小时前
第二讲 Vscode+Python+anaconda 高阶环境配置
ide·vscode·python
峥嵘life15 小时前
Android Studio新版本编译release版本apk实现
android·ide·android studio