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

配置文件头注释

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

配置函数头注释

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

相关推荐
devilnumber9 小时前
避坑_IDEA 提取方法(Extract Method)工具
java·ide·intellij-idea
golang学习记14 小时前
最新版VS Code开发Spring Boot项目保姆级教程
java·spring boot·vscode·后端
Navicat中国21 小时前
SQL 编辑器生产力:重构与实时错误检测
数据库·sql·重构·编辑器·navicat
2501_915918412 天前
在 Xcode 中运行和调试单元测试的完整指南
ide·vscode·macos·ios·单元测试·个人开发·xcode
面壁的熊猫2 天前
工作和学习中的高效工具
vscode
不爱吃鱼的蔓热莓3 天前
释放VSCode插件占用系统盘垃圾
ide·vscode·编辑器
2501_915106323 天前
iOS开发之Xcode常用调试技巧总结
ide·vscode·ios·objective-c·个人开发·swift·敏捷流程
易知微EasyV数据可视化3 天前
会插卡片的编辑器:在 Agent 输入框里混排文字与结构化内容
人工智能·经验分享·编辑器·agent·设计
打工仔折腾 AI3 天前
SQL 编辑器不是高级记事本:KStudio 与 KSQL Developer 的建表与增删改查手法
数据库·人工智能·后端·python·sql·编辑器·ai agent 实战
志尊宝3 天前
AI原生前端开发(001):Cursor编辑器深度使用从入门到精通
前端·编辑器·ai-native