doxygen的使用(二)给代码添加javadoc风格的注释
原创文章,欢迎阅读,禁止转载。
本文记一下javadoc风格注释的写法,这些特殊格式的注释称作标签。按照这种规范写的注释才能生成到文档中。
块注释的写法
/**
* @brief 这个块注释
* doxygen标签就是写在这里(除了单行注释)
* 格式为双星开始"/** ... */",标签可以写多行
*/
单行注释的写法
int var; ///< 用"///<"的是单行注释
int abc; ///< 常用于全局变量、成员变量、结构体成员、枚举值等
(标签用'@'和'\'开头都是可以的)
C++常用的标签有:
@file 要文档化的文件,这个必须写,否则文件中的全部忽略
@author 作者
@date 日期
@brief 功能或行为描述,可以多行
@param 参数
@param[out] 输出参数
@param[in] 输入参数
@return 返回说明
@retval 返回值具体说明
@note 备注
@see 相关项(貌似不能写typedef的函数指针)
@todo 待办事项
一些高级的标签
@mainpage 标识本文会显示在手册主页上,在该段中写各种html代码即可
这是我写的注释的例子(export.h)
/**
* @file export.h
* @author zhaojk
* @brief 注释标注,试试自动生成文档的效果
* @version 0.1
* @note 其中file标签必须写
* @todo 看帮助手册,给我的手册做个主页
*/ /**
* @brief 回调参数原型
*/
typedef void(EventCallBack*)(int event,void* param); /**
* @brief 事件ID类型
*/
typedef int EVENTID; /**
* @struct 用户信息
*/
typedef struct
{
char ip[]; ///< IP地址
int port; ///< 端口号
}Adddess; /**
* @enum
*/
enum EmDeviceType
{
Device_28181=, ///< 28181设备
Device_sip, ///< sip设备
Device_onvif, ///< onvif设备
Device_other //没按规范注释就不会出现在手册
}; void* g_Instance; ///<全局实例 /**
* @brief 设置事件回调
* @param cbFun 事件回调函数
* @param cbParam 用户参数
* @return 返回操作结果
* @retval true成功,false失败
* @see EventCallBack
*/
bool SetCallBack(EventCallBack cbFun,void* cbParam); /**
* @brief 获取版本号
* @param[out] version 返回的版本号
*/
void GetVersion(char version[]); /**
* @brief 打开数据库
* @param dbname 数据库名称
* @param username 用户名
* @param passwd 密码
* @return 返回错误码
* @see CloseDB
*/
int OpenDB(char* dbname,char* username,char* passwd); /**
* @brief 关闭数据库
* @return void
* @see EmDeviceType
*/
void CloseDB();
再来一个手册主页的例子(mainpage.h)
/**
* @mainpage 这是主页
* @brief 这是本手册的主页<br>这是第二行
* @author zhaojk
*/
了解更多
常用标签的使用,请看doxygen的参考手册,也可以看一下开源库。
更多更高级的标签,请看参考手册
貌似对html格式和md格式有支持。
原创文章,欢迎阅读,禁止转载。
doxygen的使用(二)给代码添加javadoc风格的注释的更多相关文章
- C#/AutoCAD 2018/ObjectArx/二次开发添加删除实体的工具函数(四)
1.添加删除实体 C# ObjectARX二次开发添加删除实体是非常容易主要代码如下: 添加实体: objId = btr.AppendEntity(entity); trans.AddNewlyCr ...
- 如何将 JavaScript 代码添加到网页中,以及 <script> 标签的属性
Hello, world! 本教程的这一部分内容是关于 JavaScript 语言本身的. 但是,我们需要一个工作环境来运行我们的脚本,由于本教程是在线的,所以浏览器是一个不错的选择.我们会尽可能少地 ...
- 使用Typescript重构axios(二十九)——添加baseURL
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
- VS中如何快捷地给自己的代码添加创建信息注释
VS中如何快捷地给自己的代码添加创建信息注释 Intro 以下讨论的都是没有使用 GIT 来管理源代码的情况,如果使用 GIT 管理源代码可直接使用VS的Git扩展就不需要考虑以下问题. 什么是创建信 ...
- 【转】iOS学习之Autolayout(代码添加约束) -- 不错不错
原文网址:http://www.cnblogs.com/HypeCheng/articles/4192154.html DECEMBER 07, 2013 学习资料 文章 Beginning Auto ...
- 【转】iOS6中的Auto Layout:通过代码添加约束
最近做的项目用到了Auto Layout,于是经过了一番大量的google,这是我看到的讲用代码创建约束最清晰的一篇教程,于是想跟更多的人分享一下.原文也比较简单,可以直接过去看,如果我翻译的 ...
- 转:TestLink1.9.3测试用例:Excel转换XML工具<二>实现代码
TestLink1.9.3测试用例:Excel转换XML工具<二>实现代码 http://blog.csdn.net/candle806/article/details/7490599 以 ...
- 给php代码添加规范的注释phpDocumentor
给php代码添加规范的注释更多参考 http://phpdoc.org/docs/latest/index.html在phpdocumentor中,注释分为文档性注释和非文档性注释.所谓文档性注释,是 ...
- u-boot移植(十二)---代码修改---支持DM9000网卡
一.准备工作 1.1 原理图 CONFIG_DM9000_BASE 片选信号是接在nGCS4引脚,若要确定网卡的基地址,则要根据片选信号的接口去确定. 在三星2440的DATASHEET中memory ...
随机推荐
- c#利用反射获取对象属性值
public static string GetObjectPropertyValue<T>(T t, string propertyname){ Type type = type ...
- 【软件工程】“谁是卧底”之NABC分析
结对编程结束之后,迎来了结队编程,经过了很长时间的思考,想到了“谁是卧底”的idea,以下是该游戏的NABC分析: N(need): 即需求,近期,内地一知名综艺节目将“谁是卧底”游戏推广到年轻人中, ...
- new和alloc的区别
简单来说,new和alloc在功能上基本没有什么区别,都是分配内存,初始化对象. 但是,调用new的话,只能通过默认的init方法来初始化对象,而alloc可以通过其他的初始化方法如:-(instan ...
- Net 分页功能的实现
首先写一个接口 1 2 3 4 5 6 public interface IPagedList { int CurrentPageIndex { get; set; } ...
- VS 2008 快捷键
注释代码:<Ctrl+K,C>取消注释:<Ctrl+K,U> 封装字段(生成get.set方法): <Ctrl+R,E> 定位大括号范围:光标放在其中一个括号的位置 ...
- Android开发环境
1: JDK 2: Eclipse 3: Android SDK 4: ADT
- Angularjs学习笔记(四)----与后端服务器通信
一.使用$http进行XHR和JSONP请求 1.1 XHR请求 GET:$http.get(url,config) POST:$http.post(url,data,config) PUT:$htt ...
- Ruby-递归和尾递归
递归和迭代的区别 递归: 1)递归就是在过程或函数里面调用自身; 2)在使用递归时,必须有一个明确的递归结束条件,称为递归出口. 迭代: 利用变量的原值推算出变量的一个新值.如果递归是自己调用自己的话 ...
- Android背景渐变色(shape,gradient)
Android设置背景色可以通过在res/drawable里定义一个xml,如下: <?xml version="1.0" encoding="utf-8" ...
- HDU 1251统计难题
统计难题 Time Limit: 4000/2000 MS (Java/Others) Memory Limit: 131070/65535 K (Java/Others)Total Submi ...