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:设置函数返回值注释行的格式
在这里插入图片描述

配置文件头注释

自动生成文件头信息如下所示:
在这里插入图片描述

配置函数头注释

自动生成的函数头信息如下所示:
在这里插入图片描述

  • 4
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值