2018-12-06 14:40:10 +08:00
|
|
|
|
# DoxyGen 常用关键字
|
|
|
|
|
|
|
2020-04-28 11:05:09 +08:00
|
|
|
|
| Keyword | Descriptions |
|
|
|
|
|
|
|---------------|--------------|
|
2018-12-06 14:40:10 +08:00
|
|
|
|
| @author | 作者 |
|
|
|
|
|
|
| @brief | 摘要 |
|
|
|
|
|
|
| @version | 版本号 |
|
|
|
|
|
|
| @date | 日期 |
|
|
|
|
|
|
| @file | 文件名，可以默认为空，DoxyGen会自己加 |
|
|
|
|
|
|
| @class | 类名 |
|
|
|
|
|
|
| @param | 函数参数 |
|
|
|
|
|
|
| @return | 函数返回值描述 |
|
|
|
|
|
|
| @exception | 函数抛异常描述 |
|
|
|
|
|
|
| @warning | 函数使用中需要注意的地方 |
|
|
|
|
|
|
| @remarks | 备注 |
|
|
|
|
|
|
| @see | see also字段 |
|
|
|
|
|
|
| @note | brief下空一行后的内容表示详细描述，但也可以不空行用note表示 |
|
|
|
|
|
|
| @par | 开始一个段落，段落名称描述由你自己指定，比如可以写一段示例代码 |
|
|
|
|
|
|
| @code | 引用代码段 |
|
|
|
|
|
|
| @endcode | 引用代码段结束 |
|
|
|
|
|
|
| @pre | 函数前置条件，比如对输入参数的要求 |
|
|
|
|
|
|
| @post | 函数后置条件，比如对系统状态的影响或返回参数的结果预期 |
|
|
|
|
|
|
| @defgroup | 模块名 |
|
|
|
|
|
|
| @name | 分组名 |
|
|
|
|
|
|
| @{ | 模块开始 |
|
|
|
|
|
|
| @} | 模块结束 |
|
|
|
|
|
|
| @deprecated | 今后可能将被废弃或已经有替代品的函数 |
|
|
|
|
|
|
| @since | 从哪个版本后开始有这个函数的 |
|
|
|
|
|
|
| @todo | 被标记的代码会在ToDo列表中出现 |
|
|
|
|
|
|
| @bug | 被标记的代码会在Bug列表中出现 |
|
|
|
|
|
|
| @test | 被标记的代码会在Test列表中出现 |
|
