# doxygen-sample

**Repository Path**: suse110/doxygen-sample

## Basic Information

- **Project Name**: doxygen-sample
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-08-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



Doxygen支持的部分常用指令，使用这些指令时需要在前面加上“\”或者“@”。
|命令|说明|
|-|-|
|@file |档案的批注说明。|
|@author |作者的信息|
|@version         |版本号|
|@date             |日期|
|@brief |用于class或function的简易说明<br>eg：@brief本函数负责打印错误信息串|
|@param[in\|out] |主要用于函数说明中，后面接参数的名字，然后再接关于该参数的说明|
|@return |描述该函数的返回值情况<br>eg: @return 本函数返回执行结果，若成功则返回TRUE，否则返回FLASE|
|@retval |描述返回值类型，格式如下：<br>@retval 返回值 简要说明<br>eg:<br>@retval NULL 空字符串<br>@retval !NULL 非空字符串|
|@pre|函数前置条件，比如对输入参数的要求,pre格式如下：<br>@pre 简要说明|
|@post|函数后置条件，比如对系统状态的影响或返回参数的结果预期|
|@par|开始一个段落，段落名称描述由你自己指定，比如可以写一段示例代码。（它一般跟code、endcode一起使用 ）par格式如下：<br>@par 扩展名字|
|@note |指定函数注意项事或重要的注解指令操作符<br>eg：@note 简要说明|
|@attention| 注意|
|@warning |警告信息|
|@enum |引用了某个枚举，Doxygen会在该枚举处产生一个链接<br>eg：@enum CTest::MyEnum|
|@var |引用了某个变量，Doxygen会在该枚举处产生一个链接 <br>eg：@var CTest::m_FileKey|
|@class |引用某个类，<br>格式：@class <name> [<header-file>] [<header-name>]<br>eg: @class CTest "inc/class.h"|
|@exception |可能产生的异常描述<br>eg:@exception 本函数执行可能会产生超出范围的异常|
|@code、@endcode|引用代码段，格式如下：<br>@code<br>简要说明(内容)<br>@endcode|
|@deprecated|指定函数过时指令操作符,引起不推荐使用的警告|
|@since|表示从那个版本起开始有了这个函数|
|@remark|表示评论，暴露给客户程序员的文档|
|@remarks|备注|