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

配置文件头注释

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

配置函数头注释

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

相关推荐
weixin_4235339920 小时前
【Windows11离线安装anaconda、python、vscode】
开发语言·vscode·python
爱分享的阿Q20 小时前
STM32现代化AI开发环境搭建:从Keil到VSCode+AI的范式转移
人工智能·vscode·stm32
Freak嵌入式20 小时前
LVGL基础知识和概念:视觉样式与资源系统
ide·驱动开发·嵌入式·lvgl·micropython·upypi
追风201921 小时前
PowerShell 7 解决 Codex 中文乱码:完整经验总结(VsCode 背景)
ide·vscode·编辑器
Curtain_Gin1 天前
windows vim 配置
linux·编辑器·vim
帅小柏1 天前
VSCode Remote SSH 一直转圈连不上服务器?踩坑全记录
服务器·vscode
深挖派1 天前
IntelliJ IDEA 2026.1 安装配置与高效开发环境搭建 (保姆级图文教程)
java·ide·intellij-idea
vonlycn1 天前
Android Studio 5.3.3 新项目编译报错解决
android·ide·android studio
H Journey1 天前
VSCode下CMake使用
vscode·cmake
9分钟带帽1 天前
vscode中配置Qt6和CMake的开发环境
c++·vscode·cmake