中财网江山万里图:Doxygen注释常用标记
来源：百度文库 编辑：中财网 时间：2024/04/19 20:53:37
Doxygen的常用注释标记，通过这些标记，可生成规范化的代码文档；也可以帮助我们管理代码。
这些标记都是写在注释块中的，详见随邮件的例子(_common/obj.h)。
说明类型：
分为摘要说明和详细说明
/brief 后紧跟摘要说明，也可以直接使用“//!”开始注释。
详细说明：在摘要说明后，间隔一行书写，见实例。
基本结构的说明标记：
/file [file name] 写文件的说明， 后跟此文件的文件名；另起一行书写此文件的说明文字。
/class [class name] 写类的说明，后跟类名；另起一行书写类的说明文字。
用于函数内部的说明标记：
这些标记会在函数的详细说明中使用不同的字体和格式，突出显示。
/param [param name] 写函数参数的说明，后跟参数名；紧跟参数的说明文字。
/return 写函数返回值得说明，后紧跟返回值得说明。
/warning 警告，后紧跟警告的内容。
/remarks 评论，后紧跟评论的内容。
可单独生成主题的说明标记：
/todo 被此标记说明的代码会在Todo列表中出现。
/bug 被此标记说明的代码会在Bug列表中出现。
/test 被此标记说明的代码会在Test列表中出现。
/deprecated 被此标记说明的代码会在deprecated列表中出现。
/defgroup [group name] [brief] 定义一个代码块，可对代码块写说明;注意group name必须是唯一的；
另起一行写详细说明
/{ 代码块开始
/} 代码块技术
格式化说明标记：
- 主题
-# 子标题1/n
说明
-# 子标题2/n
说明
生成文档中可显示为编号的列表
注意：在注释中，可完全使用html格式化标记。
以上是常用的标记的简要说明；还是建议大家看doxygen的文档来熟悉一下。