C语言项目中Doxygen的注释格式

1. 文件注释

/**
  * @file Calculate.h
  * @brief Calculate头文件
  * @details 支持加法运算、减法运算
  * @author G-Lin
  * @version V1.0
  * @date 2022-12-18
  * @copyright Copyright (c) 2022-2023 xxxx有限公司
  * @attention
  * 硬件平台：Cortex-A8
  * @par 修改日志:
  * <table>
  * <tr><th>Date          <th>Version    <th>Author    <th>Description
  * <tr><td>2022/12/18    <td>V1.0       <td>G-Lin     <td>创建初始版本
  * </table>
 */

2. 函数注释

/**
 * @brief 加法运算
 * @param[in] a
 * @param[in] b
 * @return 返回a+b的和
 * @retval 0 成功
 * @retval 1 失败
 */

3. 变量注释

3.1在变量后注释

int nVal; ///<定义一个整型变量nVal

3.2在变量上一行注释

///定义一个浮点型变量
float fVal;

4. 枚举注释

/**
 * @brief 返回值状态
 */
typedef enum {
    SUCCESS = 1, ///<成功
    FAIL,        ///<失败
    TIMEOUT      ///<超时
}RETURN_VALUE;

5.结构体注释

/**
 * @brief		IEC104对象.
 * @details
 */
typedef struct
{
    int t0; ///< 默认值10s
    int t1; ///< 默认值12s
    int t2; ///< 默认值5s
    int t3; ///< 默认值15s
} IEC104Object;

6.宏定义注释

///从设备ID为1
#define MODBUS_SLAVE_ID  1

#define MODBUS_FUNC_CODE 0x03 ///< 功能码03