原创文章,欢迎阅读,禁止转载。

本文记一下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风格的注释的更多相关文章

  1. C#/AutoCAD 2018/ObjectArx/二次开发添加删除实体的工具函数(四)

    1.添加删除实体 C# ObjectARX二次开发添加删除实体是非常容易主要代码如下: 添加实体: objId = btr.AppendEntity(entity); trans.AddNewlyCr ...

  2. 如何将 JavaScript 代码添加到网页中,以及 <script> 标签的属性

    Hello, world! 本教程的这一部分内容是关于 JavaScript 语言本身的. 但是,我们需要一个工作环境来运行我们的脚本,由于本教程是在线的,所以浏览器是一个不错的选择.我们会尽可能少地 ...

  3. 使用Typescript重构axios(二十九)——添加baseURL

    0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...

  4. VS中如何快捷地给自己的代码添加创建信息注释

    VS中如何快捷地给自己的代码添加创建信息注释 Intro 以下讨论的都是没有使用 GIT 来管理源代码的情况,如果使用 GIT 管理源代码可直接使用VS的Git扩展就不需要考虑以下问题. 什么是创建信 ...

  5. 【转】iOS学习之Autolayout(代码添加约束) -- 不错不错

    原文网址:http://www.cnblogs.com/HypeCheng/articles/4192154.html DECEMBER 07, 2013 学习资料 文章 Beginning Auto ...

  6. 【转】iOS6中的Auto Layout:通过代码添加约束

        最近做的项目用到了Auto Layout,于是经过了一番大量的google,这是我看到的讲用代码创建约束最清晰的一篇教程,于是想跟更多的人分享一下.原文也比较简单,可以直接过去看,如果我翻译的 ...

  7. 转:TestLink1.9.3测试用例:Excel转换XML工具<二>实现代码

    TestLink1.9.3测试用例:Excel转换XML工具<二>实现代码 http://blog.csdn.net/candle806/article/details/7490599 以 ...

  8. 给php代码添加规范的注释phpDocumentor

    给php代码添加规范的注释更多参考 http://phpdoc.org/docs/latest/index.html在phpdocumentor中,注释分为文档性注释和非文档性注释.所谓文档性注释,是 ...

  9. u-boot移植(十二)---代码修改---支持DM9000网卡

    一.准备工作 1.1 原理图 CONFIG_DM9000_BASE 片选信号是接在nGCS4引脚,若要确定网卡的基地址,则要根据片选信号的接口去确定. 在三星2440的DATASHEET中memory ...

随机推荐

  1. 初学JQuery笔记

    extend()函数是jQuery的基础函数之一,作用是扩展现有的对象 <script type="text/javascript" src="jquery-1.5 ...

  2. C语言基础补习

    coolshell 中一个小例子在VC6.0编译后反汇编结果仅作记录: 源码: #include <stdio.h> int main(void) { ]; printf("%x ...

  3. YII2学习第一天

    YII2学习第一天,之前稍微看了看TP,感觉和自己的理念不是很符合,然后转学YII2了. 使用的文档是https://github.com/yiisoft/yii2/tree/master/docs/ ...

  4. 四元数quaternion

    四元数的简单方法运用四元数在Unity3D中的作用就是拿来表示旋转. AngleAxis 创建一个旋转,绕着某个轴旋转,返回结果是一个四元数. 跟ToAngleAxis实现的是相反的功能. Angle ...

  5. Unity Application 前后台切换调用关系

    [Unity Application 前后台切换调用关系] http://blog.csdn.net/aa4790139/article/details/48087877

  6. Python学习之路——基础篇(1)字符串格式化

    字符串格式化 Python的字符串格式化有两种方式: 百分号方式.format方式  百分号的方式相对来说比较老,而format方式则是比较先进的方式,企图替换古老的方式,目前两者并存. 百分号方式 ...

  7. json_decode返回null 和synax error原因及处理

    $checkLogin ='[{"gdsincode":"1103293","gdsname":"鲜美来带鱼段800g" ...

  8. Chrome & Linux font

    1 $ sudo apt-get install texlive-full # 较大 2 $ mkdir -p ~/.fonts 3 下载这个win7字体包解压后放到~/.fonts下 4 $ sud ...

  9. javac 命令出现 找不到文件 问题及解决办法

    如果环境配置好了,使用java -version回车可以正常查看到版本信息. 使用javac Demo.java 如果提示文件找不到 可能原因1: 源文件与当前命令行不在同目录下,这时候就要切换到同一 ...

  10. NGUI 按钮点击音效统一管理开启与关闭

    之前就只是简单的在每个按钮(或者需要绑定单击事件的UISprite)对象上添加PlaySound组件,但这样就无法统一去设置按钮单击音效的开启与关闭! 由于我都是使用UIEventListener.G ...