VSCODE 使用插件 Doxygen Documentation Generator

VSCODE 使用插件 Doxygen Documentation Generator

1.安装插件Doxygen Documentation Generator

在这里插入图片描述

2.修改相关代码(不改也可以,可跳过)

方法1,打开设置,从插件处更改

更改邮箱和姓名
在这里插入图片描述
在这一页我们还能看到许多可以自定义的地方,不过其它大多不痛不痒,我就偷懒不改了

方法2,修改setting.json

其实方法1最终自动修改的也是setting.json,只是可视化加上容易懂了。
组合键ctrl+shift+p打开命令,输入setting搜索,打开setting.json
添加以下内容

/*GXT-Doxygen Documentation Generator插件使用-Begin*/
"doxdocgen.generic.authorName": "gxt_kt",//更改作者名
"doxdocgen.generic.authorEmail": "gxt_kt@163.com",//更改邮箱
/*GXT-Doxygen Documentation Generator插件使用-End*/

在这里插入图片描述
如果出现红色报错,记得看下上面最后一行是不是漏了,
保存好就可以了

3.使用

在文件首行输入/**,然后按下回车,就可以看到自动补全的注释了
函数上方一行也是这么操作,显示效果示例
在这里插入图片描述

4.额外补充(可不看)

想要更加自定义可以修改相关代码,方法见2.2小节
这里给出一份demo,大部分不是我写的,也可以直接使用,不过效果实测一般般,细节还需要打磨,就放出来,有兴趣的可以试试

/*GXT-Doxygen Documentation Generator插件使用-Begin*/
// 作者名和邮箱
"doxdocgen.generic.authorName": "gxt_kt",
"doxdocgen.generic.authorEmail": "gxt_kt@163.com",
"doxdocgen.generic.authorTag": "@Author : {author} email:{email}",
// 日期格式
"doxdocgen.generic.dateFormat": "YYYY-MM-DD",
"doxdocgen.generic.dateTemplate": "@Creat Date : {date}",
// 简介格式
"doxdocgen.generic.briefTemplate": "@brief{indent:8}{text}",
// 文件注释的格式
"doxdocgen.file.fileTemplate": "@File Name: {name}",
"doxdocgen.file.versionTag": "@Version : 1.0",
"doxdocgen.file.copyrightTag": [
    "@copyright Copyright (c) {year} XXXX技术有限公司"
],
// 自定义文件注释格式
"doxdocgen.file.customTag": [
    "modification history :",
    "Date:       Version:      Author:     ",
    "Changes: ",
],
// 文件注释组成及顺序
"doxdocgen.file.fileOrder": [
    "file",		// @file
    "brief",	// @brief 简介
    "author",	// 作者
    "version",	// 版本
    "date",		// 日期
    "empty",	// 空行
    // "copyright",// 版权
    // "custom"	// 自定义
],
// 参数注释和返回注释的格式
"doxdocgen.generic.paramTemplate": "@param{indent:8}{param}: ",
"doxdocgen.generic.returnTemplate": "@return{indent:8}{type}: ",
// 函数注释组成及顺序
"doxdocgen.generic.order": [
    "brief",
    "tparam",
    "param",
    "return"
],
/*GXT-Doxygen Documentation Generator插件使用-End*/
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值