基于STM32的Doxygen使用簡明手冊
加入技術(shù)交流群
一、添加類型
本文引用地址：http://www.ex-cimer.com/article/201611/318442.htm1、添加首頁(mainpage)：
格式：
/
mainpage RIOM DSP Software Library
*
* Introduction
*
* This user manual describes the CMSIS DSP software library
*/
關(guān)鍵字：
mainpage
描述：
用以顯示在首頁中，一般用于對整個工程進行描述。
2、添加define分組(defgroup)：
格式：
/ @defgroup ZHM2
* @{
*/
#define XXX YYY
/
* @}
*/
關(guān)鍵字：
@defgroup name
@{
@}
描述：
定義一個define分組，用以顯示在生成的文件中，一般多出現(xiàn)在.h文件中。
3、添加到分組(addtogroup)
格式：
/ @addtogroup STM32F2xx_StdPeriph_Driver
* @{
*/
XXXX
/
* @}
*/
關(guān)鍵字：
@addtogroup name
@{
@}
描述：
把一些東西添加到某個分組中去，該分組可以定義在其他文件下，Doxygen會自動搜索該分組，然后將需要添加的添加到該分組。可以進行跨文件關(guān)聯(lián)。
通過addtogroup可以形成樹結(jié)構(gòu)，如果原來不存在該分組，它會自動新建該分組，然后添加到該分組。
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
*/
關(guān)鍵字：
@file：文件名，xx.c; zz.h等
@author：作者
@version：版本號
@date：日期
@brief：簡介
@copy/@attention：詳細(xì)描述
描述：
用以說明整個文件的各種信息。
5、函數(shù)注釋：
格式：
/
* @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
*/
關(guān)鍵字：
@brief：對函數(shù)簡要描述
@param：參數(shù)說明，以’:’作為參數(shù)結(jié)束標(biāo)志；
@arg：參數(shù)里面可選擇參量列舉，對于可數(shù)情況可進行參量列舉，同樣以’:’作為參數(shù)結(jié)束標(biāo)志；
@note：注釋，配合brief一起使用可以達(dá)到很好的注釋效果；
@retval：返回值說明。
描述：
對函數(shù)體進行說明，包括功能，參數(shù)和返回值。
二、字體段落操作
編號 | 功能 | 格式 | 描述 |
1 | 以開頭，以結(jié)束。 | 用以將段落或者字體加粗 | |
2 | * | 以 開頭，以結(jié)束 | 段落加粗加大 |
3 | 以 | 段落居中 | |
4 | @verbatim*@endverbatim | 以@verbatim開頭，以@endverbatim結(jié)束 | 用于建立一個框，來說明整個文件或者函數(shù)的功能。 |
三、特殊符號添加:
編號 | 代碼 | 效果 | 說明 |
1 | © | 版權(quán)標(biāo)志 | |
四、.c和.h的常用規(guī)范:
1、.c文件開頭定義一些常用規(guī)范如下所示。
/* Includes ------------------------------------------------------------------*/
/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/* Private functions ---------------------------------------------------------*/
最后加一個copyright。
2、.h文件開頭的一些常用規(guī)范如下所示：
/* Define to prevent recursive inclusion -------------------------------------*/
/* Includes ------------------------------------------------------------------*/
/* Exported types ------------------------------------------------------------*/
/* Exported constants --------------------------------------------------------*/
/* Exported macro ------------------------------------------------------------*/
/* Exported functions --------------------------------------------------------*/
最后加一個copyright。
評論