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支持不同的注释风格;

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

/*!
 * ... text ...
 */
///
/// ... 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 注意事项。
  */

原文地址:https://blog.csdn.net/louxiaofei_java/article/details/129266245

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。

如若转载,请注明出处:http://www.7code.cn/show_9583.html

如若内容造成侵权/违法违规/事实不符,请联系代码007邮箱:suwngjj01@126.com进行投诉反馈,一经查实,立即删除

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注