Doxygen注释块
Doxygen注释块
Doxygen注释块其实就是在C、C++注释块的基础添加一些额外标识，使Doxygen把它识别出来，并将它组织到生成的文档中。
在每个代码中都可以有两类描述：一类是brief描述，另一类就是detailed。两种都是可选的，但不能同时没有。简述（brief）就是在一行内简要的描述，而详细描述（detailed）则提供更长、更详细的文档。
在Doxygen中，主要通过以下方法将注释块标识成详细描述：
- JavaDoc风格，在C风格注释块开始使用两个星号‘*’
/**
*详细描述
*/
- Qt风格代码注释，及在C风格注释块开始处添加一个叹号‘！’
/*!
*详细描述
*/
- 连续使用两个以上C++代码注释行所组成的注释块，而每个注释行开始处要多写一个斜杠或者写一个叹号
///
/// 详细描述
///
注意以下几点
1、Doxygen并不处理所有的注释
2、注释应该写在对应函数或变量前面
3、先从文档开始注释，然后是所在文件的全局函数、结构体、枚举变量、命名空间->命名空间中的类->成员函数和成员变量
4、Doxygen无法为dll中定义的类导出文档
注释常用指令
| 指令 | 说明 |
|---|---|
| @file | 档案的批注说明 |
| @author | 作者的信息 |
| @brief | 用于class或function的简要说明 eg:@brief 本函数负责打印错误信息 |
| @param | 主要用于函数的说明中，后面接参数的名字，然后再接关于该参数的说明 |
| @return | 描述该函数的返回值情况 eg:@return 本函数返回执行结果，若成功则返回True，否则返回False |
| @retval | 描述返回值类型 |
| @note | 注解 |
| @todo | 待办事项，链接到所有TODO 汇总的TODO 列表 |
| @deprecated | 已废弃函数 |
| @details | 详细描述 |
| @since | 通常用来说明从什么版本、时间写此部分代码。 |
| @bug | 缺陷，链接到所有缺陷汇总的缺陷列表 |
| @fn | 函数说明 |
| @attention | 注意 |
| @warning | 警告信息 |
| @enum | 引用了某个枚举 |
| @var | 引用了某个变量 |
| @class | 引用某个类，格式：@class[][] eg:class CTest "inc/class.h" |
| @exception | 可能产生的异常描述 eg:@exception 本函数执行可能会产生超出范围的异常 |
