VSCODE 使用插件 Doxygen Documentation Generator

vscode 配置doxygen注释和snippet 本文介绍了如何在VSCode中配置Doxygen注释和代码片段,以提升C/C++代码的文档化效率。Doxygen注释原则涵盖了文件头、命名空间、类、结构、枚举、函数、变量、模块和分组的标注。文章还提供了常用的Doxygen指令表格,如@file、@brief、@author等,并展示了文件注释的示例代码。通过这些配置,开发者可以快速生成规范的代码注释,提升代码的可读性和维护性。 阅读详情
AI摘要

本文介绍如何在VSCode中安装并配置DoxygenDocumentationGenerator插件,演示如何自定义作者信息和文档模板,提升代码注释效率。

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*/
vscode编程小插件之Doxygen和Better Align 小插件Doxygen、Better Align、SSH的安装、配置与应用 阅读详情

相关推荐

doxygen代码文档生成工具

可以按照doxygen规定的格式编写代码注释,然后利用doxygen工具直接生成参考文档

【Doxygen】Vscode 插件 DoxyGen Documentation Generator C语言详细设置

Doxygen Documentation Generator C语言详细设置

qq_39030013的博客 4505

一篇讲透:豆包、元宝、DeepSeek、Kimi、WorkBuddy,职场里到底怎么分工

这篇文章深入分析了当前主流AI工具(WorkBuddy、豆包、腾讯元宝、DeepSeek、Kimi)的特点和使用场景,帮助读者根据不同工作需求选择合适的AI助手。核心观点包括: AI工具各有所长:豆包适合快速创作初稿,元宝擅长信息检索整理,DeepSeek强于逻辑分析,Kimi专精文本处理,WorkBuddy则更适合任务推进和成果交付。 使用前需明确需求:是要创意发散、信息整理,还是任务执行?不同阶段应选用不同工具组合。 提供了6个具体职场场景的解决方案,包括文章创作、课程设计、会议纪要等,并给出详细的操作

weixin_39284145的博客 1万+

VSCode 自动生成 Doxygen 格式注释

本文介绍了在VS Code中使用Doxygen注释生成插件的方法。推荐安装cschlosser.doxdocgen插件,详细说明了安装步骤和配置过程。通过JSON配置示例展示了如何设置文件注释模板(包含版权信息、修改日志等)和函数注释模板(含参数说明、返回值等)。配置后只需输入"/**"回车即可自动生成规范的Doxygen注释,包括文件头信息(作者、版本、日期)和函数说明(参数、返回值)。该工具能有效提高代码注释效率,适合团队协作开发。

人无远虑,必有近忧 7988

第四章 自定义组件、动画

第三章 自定义组件、动画 (一)自定义View 1.1) onMeasure:对当前View的尺寸进行测量 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) widthMeasureSpec和heightMeasureSpec包含测量模式和尺寸大小 int widthMode = MeasureSpec....

Stay Hungry Stay Foolish 求知若饥 虚心若愚 8135

MT25QL256完整操作指南:从ID读取到4KB扇区擦除(附华大SPI例程)

本文提供了MT25QL256 NOR FLASH在华大MCU上的完整驱动开发指南。内容涵盖从SPI初始化、器件ID读取、状态寄存器查询,到核心的页编程和4KB扇区擦除操作,并分享了构建健壮驱动框架、处理跨页写入及常见调试问题的实战经验。

tt34567的博客 890

Doxygen文档生成工具

Doxygen代码文档生成工具 文章目录Doxygen代码文档生成工具DoxygenDoxygen的注释vscode插件Doxygen实际使用 Doxygen 根据百度百科说法,Doxygen是一种开源的,跨平台的文档系统,支持C、C++、Java、Objective-C语言,可以生成在线的HTML参考手册或者离线的Latex、RTF参考手册 Doxygen是一种程序的文件产生工具,可以将程序中特定的注释转换成为说明文件。 可以对未归档的源文件,可以通过配置Doxygen来提取代码结构 可以生成依赖

ahelloyou的博客 8749

DaVinci Developer中枚举类型变量的创建与实战应用

本文详细介绍了在DaVinci Developer中创建和使用枚举类型变量的方法与实战应用。通过智能温控系统的案例,阐述了枚举类型在嵌入式开发中的核心价值,包括提升代码可读性、类型安全性和维护便捷性。文章还提供了枚举类型在状态机实现和多模块协同中的高级应用技巧,以及调试与优化的实用建议。

ik678901234的博客 514

VSCODE 使用插件 Doxygen Documentation Generator 配置 TaoToken 的完整指南

在 VSCODE 中用 Doxygen Documentation Generator 插件配置 TaoToken,只需在 setting.json 填入 Base URL、API Key 与 Model ID 三件套,即可统一模型调用通道。本文提供可复制配置片段、/** 自动生成注释验证步骤,以及 401、choices 报错排查方法。官网:https://taotoken.net/?utm_source=taotoken_aicg_blog_end

weixin_35756373的博客 9

AI影像组学在结直肠癌诊疗中的应用:从特征提取到临床决策

影像组学通过高通量计算从医学影像中提取定量特征,揭示肿瘤内部的微观生物学行为,这些特征反映了纹理异质性、形状不规则度等影像表型。其核心原理在于将图像数据转化为可分析的数字特征,结合机器学习算法进行模式识别,从而实现对疾病状态的精准预测。这一技术的价值在于能够无创、定量地评估肿瘤特性,为精准医疗提供关键支持。在临床实践中,AI驱动的影像组学模型广泛应用于结直肠癌的诊疗全链条,包括肿瘤良恶性鉴别、基因突变预测、治疗反应评估和预后分析等场景。通过整合影像组学特征与临床数据,可以构建预测模型,辅助医生进行更准确的诊

weixin_28295799的博客 411

从数据到图片:手把手构建FMCW雷达人体行为识别数据集(行走、跌倒、喝水等6类动作)

本文详细解析了如何利用FMCW雷达构建人体行为识别数据集,涵盖行走、跌倒、喝水等6类动作。通过多普勒特征可视化、图像标准化处理和自动化流水线设计,将原始雷达信号转化为高质量时频图像数据集,为智能家居和健康监护等应用提供可靠数据支持。

weixin_30706691的博客 388

VSCode插件-Doxygen Documentation Generator

可以为程序文件和函数生成注释。

he3kys的博客 1532

MoCap 动作捕捉开源库教程

数据通过 tf2 和支持不同 QoS 设置的 /poses 主题直接发布。该软件包最初是为 Crazyswarm 开发的,用于跟踪多达 50 个飞行机器人。

机器人控制与仿真应用 1309

[转] VSCODE 使用插件 Doxygen Documentation Generator

https://blog.csdn.net/my_id_kt/article/details/122852676

sroman的博客 1613

本地快速部署谷歌开放模型Gemma教程(基于Ollama)

谷歌最近发布了新一代开源AI模型Gemma,此次发布的 Gemma 相比自家的 Gemini 更加轻量级,模型权重也一并开源。不仅可以在笔记本电脑上运行,而且还免费可商用,支持中文。运行速度飞快。

特立独行的博客 6725

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

VSCode插件Doxygen Documentation Generator:用TaoToken统一Key生成注释模板的配置与验证

在 VSCode 中配置 Doxygen Documentation Generator 插件,用 settings.json 片段统一注释模板,再通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 获取统一 Key 与 API 地址,让脚本为函数签名生成注释草稿,并附 401、choices 报错排查与验证步骤。

weixin_42576410的博客 7

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册,内含HL7和ASTM)

VSCode 自动添加函数注释头插件怎么配?Doxygen Documentation Generator 与 TaoToken 的协作实践

VSCode 函数注释头配置实战:用 Doxygen Documentation Generator 插件配合 settings.json 一键生成 @param、@return 模板,再通过 TaoToken 统一 API 通道接入 AI 补全描述,附 401 与 local proxy failed 排查路径。官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end

weixin_42579969的博客 8

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

efm32 入门.pdf

本PDF共计22页,介绍的是操作驱动API,下载与否自己斟酌。

VSCode 插件 Doxygen Documentation Generator 配 TaoToken:settings.json 骨架与注释生成验证

在 VSCode 中为 C/C++ 项目配置 Doxygen Documentation Generator 插件,复制 settings.json 骨架即可让 /** 触发规范注释。本文提供完整配置与验证步骤,并说明如何通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 接入模型补全 @brief 语义描述,统一注释通道。

weixin_42609225的博客 12

【VScode实用生产力插件】

Vcode 配置成生产力 1. Plantuml插件 [插件名:Plantuml] 简介:PlantUML是一个可以快速编写UML图的组件。支持【顺序图,用例图,类图,对象图,活动图(旧语法),组件图,部署图,状态图,时序图】【JSON数据,YAML数据,网络图(nwdiag),线框图形界面或UI模拟(盐),架构图,规范和描述语言(SDL),Ditaa图,甘特图,思维导图,图示工作分解结构图(WBS),用AsciiMath或JLaTeXMath符号进行数学计算,实体关系图(IE/ER)】 官网 http

weixin_43966547的博客 2416

注释插件使用 Doxygen Documentation Generator

在setting中添加内容。

Car12 588

【Doxygen】Vscode 插件 DoxyGen Documentation Generator C语言详细设置:从零生成可维护的注释文档

用 VSCode 的 DoxyGen Documentation Generator 插件为 C 语言项目自动生成 Doxygen 注释模板,输入 /** 回车即可填充参数与返回值。本文给出可复制的 settings.json 与 Doxyfile 配置,串起注释规范、HTML 文档生成与常见报错排查,并说明如何通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 调用模型辅助排查配置。

weixin_42376614的博客 9

【Doxygen】Vscode 插件 DoxyGen Documentation Generator C语言详细设置:从 config.toml 骨架到注释生成验证

用 Vscode 的 DoxyGen Documentation Generator 插件为 C 语言项目自动生成 Doxygen 注释骨架,从 settings.json 模板到 Doxyfile 关键项一次配齐。文中给出可复制的 config 骨架与验证步骤,并说明如何通过 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 接入 API 辅助补全注释文本。

weixin_42591908的博客 8

VSCODE 使用插件 Doxygen Documentation Generator:setting.json 配置与注释模板落地

在 VS Code 中安装 Doxygen Documentation Generator 插件后,打开 setting.json 粘贴 authorName 与 authorTag 两行配置即可让函数注释自动补齐参数骨架。本文给出可复制的完整模板与触发验证步骤,并对照 401、local proxy failed 等报错排查来源。配合 TaoToken 官网 https://taotoken.net/?utm_source=taotoken_aicg_blog_end 可叠加 AI 补全描述。

weixin_42527589的博客 148

vscode 自动生成Doxygen格式注释

前言 ​ 程序中注释的规范和统一性的重要性不言而喻,本文就推荐一种在用vscode编写代码时自动化生成标准化注释格式的方法,关于Doxygen规范及其使用可查看博文 代码注释规范之Doxygen。 ​ 本方法仅作为Doxygen注释的辅助作用。 Vs code自动生成Doxygen格式注释 环境 Vs code Doxygen Documentation Generator 插件 Doxygen Documentation Generator插件使用及配置 安装插件后,File–Prefer

ABC_ORANGE的博客 5114

vscode 插件

office viewer

u010669626的博客 339

【面向小白】vscode最佳实践(4)—— 搭建c/c++环境2(插件安装,vscode基础操作讲解)

本文讲解了vscode开发c/c++的必装插件和设置。

weixin_41096870的博客 1184
上一篇: VSCODE 使用One Dark Pro并优化
下一篇: VSCODE使用TODO HighLight报错
gogongxt
博客等级 码龄5年 136粉丝 107原创
评论 3
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值