Doxygen格式命令

Doxygen格式命令

注释命令

注释命令	描述
@brief	概要信息
@details	详细描述
@par	开始一个段落，段名自定义
@param	标记参数意义
@return	描述返回意义
@retval	描述返回值意义
@todo	对将要做的事情进行注释
@bug	缺陷，链接到所有缺陷汇总的缺陷列表
@since	通常用来说明从什么版本、时间写此部分代码
@pre	用来说明代码项的前提条件
@post	用来说明代码项之后的使用条件
@code	在注释中开始说明一段代码，直到@endcode命令
@endcode	注释中代码段的结束
@fn	函数说明
@include	包含文件
@var	标注变量
@enum	标注枚举
@struct	标注结构体
@class	标注类
@note	描述一些注意事项
@addtogroup	添加到一个组

文件注释模板

/**
 * @file 文件名
 * @brief 文件概要信息描述
 * @author 作者
 * @version 版本
 * @date 日期
 * 
 * @copyright 版权信息
 * 
 * @par 修改日志:
 * <table>
 * <tr><th>Date	 <th>Version  <th>Author  <th>Description
 * <tr><td>日期 	<td>版本     <td>作者      <td>说明
 * </table>
 */

函数注释模板

/**
 * @brief  函数功能概要信息
 * @param[in]  输入参数       输入参数描述信息
 * @param[out] 输出参数       输出参数描述信息
 * @return 返回类型				
 * @retval 返回值	返回值意义描述信息 
 */