Doxygen的注释规则

注释格式
/**
…
…
*/

或
/*!
…
*/

或
/// …

或
//!
//! …
//!

常用关键字列表

关键字	标签名	功能描述
-		生成一个黑心圆.
-#		指定按顺序标记。
::		指定连接函数功能。（注：空格和“:”有连接功能,但建议还是使用”::”。只对函数有用。）
@mainpage	首页	描述内容，并将注释提到首页标签中去
@section		开始一个段落，段落名称描述由你自己指定
@copyright	版权所有
@file		文件名，可以默认为空，DoxyGen会自己加
@brief		概要信息,简短描述，自动列在注释前。
@name	自定义名	分组名强制给注释段给定自定义名称，自动列在注释前，比@brief还前。
@author	作者
@version	版本
@date	日期
@note	注解
@attention	注意
@warning	警告
@exception	异常	可能产生的异常描述 eg: @exception 本函数执行可能会产生超出范围的异常
@post	后置条件	用来说明代码项之后的使用条件。
@remarks	备注
@par	自定义名	开始一个段落，段落名称描述由你自己指定
@param	参数	主要用于函数说明中，后面接参数的名字，然后再接关于该参数的说明
@return	返回	描述该函数的返回值情况eg: @return 本函数返回执行结果，若成功则返回TRUE，否则返回FLASE
@retval	返回值	描述返回值类型 eg: @retval NULL 空字符串。@retval !NULL 非空字符串
@var	变量	引出了某个变量，Doxygen会在该变量处产生一个链接，归纳到变量列表中去。
@enum	枚举	引出了某个枚举，Doxygen会在该枚举处产生一个链接，归纳到枚举列表中去。
@struct	结构体	引出了某个结构体，Doxygen会在该枚举处产生一个链接，归纳到结构体列表中去。
@class	类	引用某个类，格式：@class [] [] eg:@class CTest “inc/class.h”
@code		在注释中开始说明一段代码，直到@endcode命令。
@endcode		在注释中代码段的结束。
@defgroup	自定义模块名
@addtogroup	自定义模块名	添加到一个组。模块
@ingroup	自定义模块名	加入到一个组 模块
@{		模块开始
@}		模块结束
@see	参见	一段包含其他部分引用的注释，中间包含对其他代码项的标识符，自动产生对其标识符的链接。
@since	自从	从哪个版本后开始有这个函数的，通常用来说明从什么版本、时间写此部分代码。
@bug	Bug：	被标记的代码会链接到 Bug列表
@todo	待办事项：	对将要做的事情进行注释，链接到 待办事项列表
@deprecated	弃用：	这个函数可能会在将来的版本中取消，链接到 待办事项列表