过隙影

个人博客

0%

Doxygen语法实践

发表于

代码规范

注意一下提到的代码规范符合Doxygen要求

参考链接CSDN关于Doxygen语法

变量批注

1
2
int a = 1; //!< 测试变量a的单行批注
int b = 1; /*!< 测试变量b的块批注 */

在每个文件的头部添加如下注释

1
2
3
4
5
6
7
8
9
10
11
12
13
/**
  ******************************************************************************
  * @file    文件名
  * @author  作者名
  * @version 版本号V0.0.1
  * @date    日期31-January-2024
  * @brief   文件作用简介
  ******************************************************************************
  * @attention
  *
  * THE PRESENT FUCTIONS WHICH IS FOR GUIDANCE ONLY
  ******************************************************************************
  */

在函数前添加如下注释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/**
 * @brief 函数简介
 * @param 形参1: 形参1说明
 * @param 形参2: 形参2说明
 * @retval 返回值说明
 */

/// 例如

/**
  * @brief  Initializes the GPIOx peripheral according to the specified
  *         parameters in the GPIO_InitStruct.
  * @param  GPIOx: where x can be (A..G) to select the GPIO peripheral.
  * @param  GPIO_InitStruct: pointer to a GPIO_InitTypeDef structure that
  *         contains the configuration information for the specified GPIO peripheral.
  * @retval None
  */
void GPIO_Init(GPIO_TypeDef* GPIOx, GPIO_InitTypeDef* GPIO_InitStruct)
{

}

在结构体或枚举变量前添加如下注释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/**
 * @brief 结构体或枚举说明
 */

typedef struct
{
    int a; //!< 成员单行注释
    int b; /*!< 成员
                换行注释块 */
}A;

// 例如

/** 
  * @brief  GPIO Init structure definition  
  */

typedef struct
{
  uint16_t GPIO_Pin;             /*!< Specifies the GPIO pins to be configured.
                                      This parameter can be any value of @ref GPIO_pins_define */

  GPIOSpeed_TypeDef GPIO_Speed;  /*!< Specifies the speed for the selected pins.
                                      This parameter can be a value of @ref GPIOSpeed_TypeDef */

  GPIOMode_TypeDef GPIO_Mode;    /*!< Specifies the operating mode for the selected pins.
                                      This parameter can be a value of @ref GPIOMode_TypeDef */
}GPIO_InitTypeDef;

/** 
  * @brief  Bit_SET and Bit_RESET enumeration  
  */

typedef enum
{ Bit_RESET = 0,
  Bit_SET
}BitAction;

Doxygen GUI frontend 软件使用

1

点击File->Save; 保存一个模板文件

2

  1. 输入项目名称(Project Name)
  2. 选择源码文件夹位置(Source code directory)
  3. 勾选递归扫描(Scan recursively)
  4. 选择生成的目标文件夹位置(Destination directory)

3

在output中取消勾选Latex选项(如果只需要html格式文档的话)

4

点击 Run doxygen 后可点击 Show HTML output 来查看