当前位置: 首页 > news >正文

doxygen自动生成文档,注释容易错位的补充

开发过程中,为了简化api开发文档的编写工作,我们可以使用doxygen的标注来进行文档注释,最后自动化的生成相关文档:
参考:https://developer.aliyun.com/article/935529
参考:https://blog.csdn.net/qq_34597963/article/details/144751954
按照相关说明,安装好doxygen,进行简单的配置后,就很可以立即使用了。

  • 使用过程中有一个变量的注释容易被忽略:
    单行注释:注释在一个新的行,前面标记“/**”后不需要符号"<“
 /**新的时间,注释放到单独行,不需要符号'<' */
int NewTime;

如果注释是放到和变量同一个行,则需要在标记“/**”后增加符号"<“。

int OldTime;/*!<旧的时间,注释放到后面,这里前面的符号'<'必不可少*/ 

如此一来,生成的文件描述才和变量一对一对应。
在这里插入图片描述

  • 函数参数描述

dt后面要有一个空格,如果函数没有返回值,不要写@return,不然会有错误提示

/**
* @brief 获取实时日期和时间
* @param[in] dt 指向返回DATETIME类型的变量
*/  
extern void GetRtc(DATETIME *dt);  

最后生成的效果就和预想的一致。
在这里插入图片描述

http://www.dtcms.com/a/121950.html

相关文章:

  • 雷电模拟器过检测技术全解析
  • 使用docker 安装向量数据库Milvus
  • 黑马 SpringAI+DeepSeek 实战:从对话机器人到企业级知识库的大模型开发全攻略
  • <《AI大模型应知应会100篇》第8篇:大模型的知识获取方式及其局限性
  • package.json配置项积累
  • 防火墙介绍
  • SpringMvc的请求-获得请求参数
  • 启山智软的营销方法有哪些优势?
  • 大数据(7)Kafka核心原理揭秘:从入门到企业级实战应用
  • 机器学习 Day10 逻辑回归
  • 设计模式 Day 5:夯实观察者模式(Boost 实战精讲)
  • excel中的VBA指令示例(二)
  • 【Java】Java 中不同类型的类详解
  • 【PVR】《Palm Vein Recognition and Large-scale Research based on Deep Learning》
  • 今日行情明日机会——20250409
  • P9242 [蓝桥杯 2023 省 B] 接龙数列
  • Anacond虚拟环境里安装GPU版本Pytorch
  • linux下截图工具的选择
  • Linux权限管理:从入门到实践
  • 网页部署到宝塔服务器上,发送请求报错?org.springframework.data.redis.RedisSystemException,让我来看看
  • 算法训练之动态规划(一)
  • 为什么在Altium原理图中画线会自动链接到附近?
  • Zephyr、FreeRTOS、RT-Thread 定时器区别分析
  • 【Ragflow】14.MinerU解析脚本,接入ragflow知识库
  • Windows 图形显示驱动开发-WDDM 2.0功能_供应和回收更改
  • Seq2Seq - GRU补充讲解
  • DP_AUX辅助通道介绍
  • Testbench设计
  • 起跑有几种起跑方式·棒球1号位
  • 【嵌入式系统设计师】知识点:第11 章 嵌入式系统设计案例分析