Doxygen注释常用标记(转)
来源:互联网 发布:定额预算软件 编辑:程序博客网 时间:2024/06/06 13:56
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的文档来熟悉一下。
- Doxygen注释常用标记(转)
- Doxygen注释常用标记
- Doxygen的常用注释标记
- doxygen 常用标记
- DoxyGen常用语法标记
- Doxygen常用标记(关键字)合集
- doxygen注释
- doxygen注释
- Mark 标记一下 Doxygen
- doxygen笔记2-常用的doxygen约定注释格式的模板
- Doxygen 文档注释详解
- Doxygen 文档注释详解
- doxygen注释块
- Doxygen 的注释格式
- Doxygen注释风格
- Doxygen注释例子
- Doxygen 文档注释详解
- 有关doxygen注释
- Doxygen心得(转)
- lua: attempt to call a table value
- 关于Service Identification,SOA服务划分和定义--2. 服务封装
- 本科毕业设计摘要--基于web的双语词对自动获取系统
- 关于Service Identification,SOA服务划分和定义--3. 服务特性
- Doxygen注释常用标记(转)
- 关于Service Identification,SOA服务划分和定义--其他
- doxygen 使用简(转)
- 使用 Lua 编写可嵌入式脚本收藏
- csdn的一个异常
- 【转贴】如何在C++中集成Lua脚本(LuaPlus篇)
- LuaPlus是Lua的C++增强
- 不应该出现在web应用部署包中的jar文件
- [转载] 让SciTE能够和IDE一样进行成员提示