Doxygen 详细使用

2023-11-17

doxygen的安装和基本使用可参考:Doxygen的安装和基本使用

  1. 常用选项

doxygen的所有选项的参考文档:doxygen官网文档

2、样式说明

doxygen可以自己自定义样式。

  1. 手写 .css文件 (可以查看doxygen的源码,进行相对应修改)

  1. 在Expert -> HTML -> HTML_EXTRA_STYLESHEET 添加自己的 .css 文件

例如:

1、查看doxygen文档的源码

2、修改样式

3、注释规范

注释可以参考官方文档:doxygen官方注释

3.1、注释风格

doxygen支持不同的注释风格;

  • javadoc 风格

/**
 * ... text ...
 */
  • Qt 风格

/*!
 * ... text ...
 */
  • C++ 注释块

///
/// ... text ...
///

或者

//!
//!... text ...
//!

3.2、注释模板

3.2.1、文件注释模板

/**
  * @file 文件名(*.h/*.c)
  * @brief 该模块功能的简介。
  * @details 使用该模块有哪些细节注意等。
  * @author 创建该文件的人名。
  * @data 该文件的创建日期(2020-03-10)。
  * @version 文件当前的版本号(V1.0.0)。
  * @copyright 版权所属公司。
  */

3.2.2、函数注释模板

/**
  * @fn 函数名
  * @brief 简述函数功能。
  * @details 提示一些注意事项或必要的技术细节。
  * @param[in] 参数名 参数注解
  * @param[out] 参数名 参数注解
  * @param[in, out] 参数名 参数注解
  * @return None (宏函数无返回值)
  * @retval 对返回值的说明
  * @see 扇入:调用了该函数的上级函数(扇入高表示该函数复用性好)
  * @see 扇出:该函数里调用了哪些下级函数(扇出高表示该函数复杂度高)
  * @note 注解。
  * @attention 注意事项。
  * @par example:
  * @code
  //代码示例
  * @endcode
  */

3.2.3、宏函数注释模板

/**
  * @def 宏函数名
  * @brief 简述函数功能。
  * @details 提示一些注意事项或必要的技术细节。
  * @param[in] 参数名 参数注解
  * @param[out] 参数名 参数注解
  * @param[in, out] 参数名 参数注解
  * @return None (宏函数无返回值)
  * @see 扇入:调用了该函数的上级函数(扇入高表示该函数复用性好)
  * @see 扇出:该函数里调用了哪些下级函数(扇出高表示该函数复杂度高)
  * @note 注解。
  * @attention 注意事项。
  * @par example:
  * @code
  //代码示例
  * @endcode
  */

3.2.4、变量/宏定义注释模板

#define MAX                //!< 最大值
Byte g_byMax = 0;          //!< 全局变量,最大值

3.2.5、枚举注释模板

/**
  * @enum 枚举名
  * @brief 简介枚举用途。
  * @details 提示一些注意事项或必要的技术细节。
  * @note 注解。
  * @attention 注意事项。
  */

3.2.6、联合注释模板

/**
  * @union 联合名
  * @brief 简介联合用途。
  * @details 提示一些注意事项或必要的技术细节。
  * @note 注解。
  * @attention 注意事项。
  */

3.2.7、结构体注释模板

/**
  * @struct 结构体名
  * @brief 简介结构体用途。
  * @details 提示一些注意事项或必要的技术细节。
  * @note 注解。
  * @attention 注意事项。
  */
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Doxygen 详细使用 的相关文章

随机推荐

  • Java面向对象编程

    对于IP地址130 63 160 2 MASK为255 255 255 0 子网号为 A 160 2 B 160 C 63 160 D 130 63 160 答案 B 将网络物理地址转换为IP地址的协议是 A IP B ICMP C ARP
  • uni-app项目中引入uView组件库

    在uni app项目中引入uView组件库 其实uView的官方文档写的很清楚了 但是作为菜鸟踩过坑的我还是记录一下 什么是uView uView是uni app生态专用的UI框架 uni app 是一个使用 Vue js 开发所有前端应用
  • Linux 中的 chmod 命令及示例

    在 Unix 操作系统中 chmod命令用于更改文件的访问模式 该名称是change mode的缩写 其中规定每个文件和目录都有一组权限来控制权限 例如谁可以读取 写入或执行该文件 其中权限分为三类 同时读 写和执行 用 r w 和 x 表
  • Java程序员需看的面试题

    进大厂是大部分程序员的梦想 而进大厂的门槛也是比较高的 所以这里整理了一份阿里 美团 滴滴 头条等大厂面试大全 对于Java后端的朋友来说应该是最全面最完整的面试备战仓库 为了更好地整理每个模块 我也参考了很多网上的优质博文和项目 力求不漏
  • 在父子页面嵌套的结构中,当父页面完成某个操作后给子页面一个回调函数

    企业级系统中有一种常见的页面结构 所有的表单都套在一个父页面里 有业务场景 要求父页面在子页面完成加载后做一些操作 如下 这些代码不是本文的重点内容 不做介绍了 这里的iframe是元素 init my iframe function if
  • 策略模式对象初始化为空解决方案及项目中具体的使用

    使用类 Component public class TaskReceiver Autowired TaskHandlerMapping mapper RabbitHandler RabbitListener queues MqTaskCo
  • 【OPENGLES】opengles-jni实例1

    首先 说明下为什么要用jni实现opengl es 在进行移动端图像算法开发的过程中 需要完成对大量的数据进行处理 opengl是在进行图形渲染或者大批量图像运算处理时有着很大的优势 如果能够在算法库开发中加入opengl 则对于提升算法运
  • dos磁盘管理命令

    dos磁盘管理命令 前言 磁盘管理命令用于日常的磁盘维护 DOS命令行提供了多种文件管理命令用于设置和管理磁盘列表 由于很多磁盘在没有安装图形界面的时候就需要对其进行操作 所以掌握DOS命令行下的磁盘管 理命令对系统管理员是十分必要的 磁盘
  • 区域气象-大气化学在线耦合模式(WRF/Chem)在大气环境领域实践技术应用

    大气污染是工农业生产 生活 交通 城市化等方面人为活动的综合结果 同时气象因素是控制大气污染的关键自然因素 大气污染问题既是局部 当地的 也是区域的 甚至是全球的 本地的污染物排放除了对当地造成严重影响外 同时还会在动力输送作用下 极大地影
  • 【小程序】解析小程序原理

    本文首发自 前端修罗场 一个专注 Web 技术 答疑解惑 面试辅导 职业发展的社区 实际学习过程中 有些同学常常会对小程序和 Web 应用之间的差别产生疑惑 它们之间到底有什么不同 Web 应用不能作为小程序吗 本期文章将会带你比较小程序和
  • JS如何判断是否为null、undefined、NaN

    判断null var exp null if exp typeof exp undefined exp 0 alert is null typeof exp undefined 排除了 undefined exp 0 排除了数字零和 fal
  • 【观影笔记】地平线:大数据时代(BBC)

    地平线 大数据时代 BBC 影片中的实例 大数据分析所需要素 感悟 影片中的实例 洛杉矶 利用预测地震余震发生的模型来预测犯罪 数据挖掘起源 约翰 格兰特Graunt 伦敦黑死病死亡记录 Phil Beales 基因生物学寻找疾病治疗方法
  • PostgreSQL 基本安装总结

    一 Mac 环境下的安装 brew install postgresql 1 1 查看当前环境版本 pg ctl V 1 2 初始化数据库 在开始使用数据库前 需要在磁盘上初始化一个数据库存储区域 通常称之为一个数据库集簇 SQL标准使用的
  • fastjson 问题

    问题 1 fastjson value 为null key 会丢失问题 2 SerializerFeature 配置参数 背景 和第三方系统进行对接 两边商量好了接口定义 有些是非必填项 从数据库查询出来的数据赋值给相应的key 有些Str
  • 会议是浪费工作时间的最佳去处

    本文为翻译初稿 更多精彩内容 敬请关注 高效能程序员的修炼 人民邮电出版社 今天你开了多少个会 这个星期呢 这个月呢 现在你再自问一下 那些会议中有多少是值得参加的 如果把相同的时间用在工作上 你又能完成多少事情 这不禁让人想知道 我们究竟
  • 【设计模式

    every blog every motto You can do more than you think https blog csdn net weixin 39190382 type blog 0 前言 设计模式 上 创建型 设计模式
  • 基于51单片机无线NRF24L01的温湿度光照采集

    接收端 原理图 发送端 原理图 实物焊接图 主端源程序 发送端程序 从机NRF24L01程序 ifndef API DEF define API DEF Define interface to nRF24L01 Define SPI pin
  • cJSON介绍与应用—基于VS以及STM32单片机

    一 cJSON介绍 cJSON是一个使用C语言编写的JSON数据解析器 具有超轻便 可移植 单文件的特点 使用MIT开源协议 cJSON的源码文件只有两个 1 cJSON h 2 cJSON c 使用的时候 只需要将这两个文件复制到工程目录
  • 数据仓库是什么?和数据库有何区别?

    在具体学习数据仓库之前先看一下数据中心的整体构架以及数据流向 DB 是现有的数据来源 可以为mysql SQLserver 文件日志等 为数据仓库提供数据来源的一般存在于现有的业务系统之中 ETL 是 Extract Transform L
  • Doxygen 详细使用

    doxygen的安装和基本使用可参考 Doxygen的安装和基本使用 常用选项 doxygen的所有选项的参考文档 doxygen官网文档 2 样式说明 doxygen可以自己自定义样式 手写 css文件 可以查看doxygen的源码 进行