附件3 Doxygen格式常用关键字表
Doxygen注释关键字(更多内容详见Doxygen手册) | ||
注释命令 | 标签名 | 功能描述 |
特殊功能 | ||
\li | 生成一个黑心圆. | |
- |
| 生成一个黑心圆. |
-# |
| 指定按顺序标记。 |
:: |
| 指定连接函数功能。(注:空格和“:”有连接功能,但建议还是使用”::”。只对函数有用。) |
文件信息 | ||
@mainpage | 首页 | 描述内容,并将注释提到首页标签中去 |
@copyright | 版权所有 |
|
@file |
| 文件名,可以默认为空,DoxyGen会自己加 |
@details | 详细描述 | |
@author | 作者 |
|
@version | 版本 |
|
@date | 日期 |
|
@remarks | 备注 |
|
@par | 自定义名 | 开始一个段落,段落名称描述由你自己指定 |
@section | 自定义名 | 开始一个段落,段落名称描述由你自己指定 |
@name | 自定义名 | 分组名强制给注释段给定自定义名称,自动列在注释前,比@brief还前。 |
@since {text} | 自从 | 通常用来说明从什么版本、时间写此部分代码。 |
@todo { things to be done } | 待办事项: | 对将要做的事情进行注释,链接到所有TODO 汇总的TODO 列表 |
模块信息 | ||
@include | 包含文件 | |
@var | 变量 | 对模块 变量 进行标注,Doxygen会在该变量处产生一个链接,归纳到变量列表中去。 |
@typedef | 对模块 变量类型 进行标注 | |
@enum | 枚举 | 对模块 枚举 进行标注,Doxygen会在该枚举处产生一个链接,归纳到枚举列表中去。 |
@struct | 结构体 | 对模块 结构体 进行标注,Doxygen会在该枚举处产生一个链接,归纳到结构体列表中去。 |
@class | 类 | 引用某个类 进行标注,格式:@class <name> [<header-file>] [<header-name>] eg:@class CTest "inc/class.h" |
@defgroup [gTag] [gName] | [gName] | 定义模块组 |
@addtogroup [gTag] |
| 添加到一个模块组 |
@ingroup [gTag] |
| 加入到一个模块组 |
@{ |
| 模块开始 |
@} |
| 模块结束 |
@code |
| 在注释中开始说明一段代码,直到@endcode命令。 |
@endcode |
| 在注释中代码段的结束。 |
@pre { description of the precondition } | 前置条件 | 用来说明代码项的前提条件。 |
@post { description of the postcondition } | 后置条件 | 用来说明代码项之后的使用条件。 |
@relates <name> | 通常用来把非成员函数的注释文档包含在类的说明文档中。 | |
函数信息 | ||
@fn | 函数说明 | |
@param | 参数 | 主要用于函数说明中,后面接参数的名字,然后再接关于该参数的说明。标记一个参数的意义 |
@prg | 列表说明参数信息 | |
@return | 返回 | 描述返回值情况eg: @return 本函数返回执行结果,若成功则返回TRUE,否则返回FLASE |
@retval | 返回值 | 描述返回值类型 eg: @retval NULL 空字符串。@retval !NULL 非空字符串 |
@note | 注解 | 开始一个段落,用来描述一些注意事项 |
提醒信息 | ||
@brief |
| 概要信息,简短描述,自动列在注释前。 |
@see {comment with reference to other items } | 参见 | 一段包含其他部分引用的注释,中间包含对其他代码项的标识符,自动产生对其标识符的引用链接。 |
@attention | 注意 |
|
@bug | Bug: | 缺陷,链接到所有缺陷汇总的缺陷列表 |
@warning {warning message } | 警告 | 一些需要注意的事情 |
@sa | 参考资料 | |
@exception <exception-object> {exception description} | 异常 | 可能产生的异常描述 eg: @exception 本函数执行可能会产生超出范围的异常 |
@deprecated | 弃用: | 已废弃函数,链接到 待办事项列表 |