为了能使代码能够被Doxygen辨认，有必要遵从Doxygen的书写规矩。注释有必要以/打头，以*/完毕。
一、增加类型
1、增加主页(mainpage)：
格局：
/
\mainpage RIOM DSP Software Library
*
* Introduction
*
* This user manual describes the CMSIS DSP software library
*/
关键字：
\mainpage
描绘：
用以显现在主页中，一般用于对整个工程进行描绘。
2、增加define分组(defgroup)：
格局：
/ @defgroup ZHM2
* @{
*/
#define XXX YYY
/
* @}
*/
关键字：
@defgroup name
@{
@}
描绘：
界说一个define分组，用以显现在生成的文件中，一般多出现在.h文件中。
3、增加到分组(addtogroup)
格局：
/ @addtogroup STM32F2xx_StdPeriph_Driver
* @{
*/
XXXX
/
* @}
*/
关键字：
@addtogroup name
@{
@}
描绘：
把一些东西增加到某个分组中去，该分组能够界说在其他文件下，Doxygen会主动查找该分组，然后将需求增加的增加到该分组。能够进行跨文件相关。
经过addtogroup能够构成树结构，假如本来不存在该分组，它会主动新建该分组，然后增加到该分组。
4、文件注释：
格局：
/
* @file main.c
* @author ZhengHangming
* @version V1.0.0
* @date 04/16/2012
* @brief This file provides all the detail functions.
* @copy
*
* THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
* WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
* TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
* DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
* FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
* CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
*
*
COPYRIGHT 2010 STMicroelectronics
*/
关键字：
@file：文件名，xx.c; zz.h等
@author：作者
@version：版本号
@date：日期
@brief：简介
@copy/@attention：详细描绘
描绘：
用以阐明整个文件的各种信息。
5、函数注释：
格局：
/
* @brief Enables or disables the specified DAC channel.
* @param DAC_Channel: The selected DAC channel.
* This parameter can be one of the following values:
* @arg DAC_Channel_1: DAC Channel1 selected
* @arg DAC_Channel_2: DAC Channel2 selected
* @param NewState: new state of the DAC channel.
* This parameter can be: ENABLE or DISABLE.
* @note When the DAC channel is enabled the trigger source can no more be modified.
* @retval None
*/
关键字：
@brief：对函数扼要描绘
@param：参数阐明，以’:’作为参数完毕标志；
@arg：参数晒干可选择参量罗列，关于可数状况可进行参量罗列，相同以’:’作为参数完毕标志；
@note：注释，合作brief一同运用能够到达很好的注释作用；
@retval：返回值阐明。
描绘：
对函数体进行阐明，包含功用，参数和返回值。
二、字体阶段操作
|
编号 |
功用 |
格局 |
描绘 |
|
1 |
|
以最初，以完毕。 |
用以将阶段或许字体加粗 |
|
2 |
* |
以 最初，以完毕 |
阶段加粗加大 |
|
3 |
|
以 |
阶段居中 |
|
4 |
@verbatim*@endverbatim |
以@verbatim最初，以@endverbatim完毕 |
用于树立一个框，来阐明整个文件或许函数的功用。 |
三、特殊符号增加:
|
编号 |
代码 |
作用 |
阐明 |
|
1 |
© |
版权标志 |
|
四、.c和.h的常用标准:
1、.c文件最初界说一些常用标准如下所示。
/* Includes ——————————————————————*/
/* Private typedef ———————————————————–*/
/* Private define ————————————————————*/
/* Private macro ————————————————————-*/
/* Private variables ———————————————————*/
/* Private function prototypes ———————————————–*/
/* Private functions ———————————————————*/
最终加一个copyright。
2、.h文件最初的一些常用标准如下所示：
/* Define to prevent recursive inclusion ————————————-*/
/* Includes ——————————————————————*/
/* Exported types ————————————————————*/
/* Exported constants ——————————————————–*/
/* Exported macro ————————————————————*/
/* Exported functions ——————————————————–*/
最终加一个copyright。
