C Doxygen实现功能分享
创始人
2024-06-22 22:30:41
0

C++编程语言应用广泛,在很多领域中都体现了非常重要的作用。编程人员应用它能够在很到程度上提高程序开发的效率。在这里我们先来了解一下有关C++ Doxygen的应用方式,以方便大家的理解。#t#

用C++ Doxygen进行可自动文档化的代码注释,可从代码中提取注释生成帮助文档。

在使用Doxygen时将需要安装下列软件:

1、安装Doxygen1.4.7,建议安装在“D:\Program Files\doxygen”

2、安装Graphviz-2.13,用于C++ Doxygen生成类图、关系图等图形,建议安装在D:\Program Files\ATT。

3、安装HtmlHelp1.3,用于生成CHM帮助文件,如果已安装了HtmlHelp其他版本则跳过。

下面对三种常见形式举例。

A. 文件头注释,\file, \brief

B. 类/结构体等的定义注释,先写名称,再写概要说明

C. 函数定义说明,先写名称,再写概要说明,然后写参数说明、返回值、注意事项、参见链接等

在函数定义中常用的有(1)参数 param(2)返回值 return (3)参见 see(4)注意项 note等

参数可指定in/out,例如@param[out] dest、@param[in,out] buffer

D. 成员变量的注释,如果注释写在变量右边,则加“<”,例如//!< ……

更深层次的标记请查看C++ Doxygen帮助中的“Documenting the code”,Doxygen用法后面演示说明。

 

 

 

  1. //! \file Ix_Observer.h A. 文件头注释,用于在帮助文件中列出文件列表  
  2. //! \brief 定义出版者和观察者的接口Ix_Subject、Ix_Observer  
  3. #pragma once  
  4. struct Ix_Subject;  
  5. struct Ix_Observer;  
  6. //! 出版者的接口 B. 类/结构体等的定义注释  
  7. /*! 出版者就是将要被观察的对象  
  8. \interface Ix_Subject  
  9. */  
  10. struct Ix_Subject  
  11. {  
  12. //! 添加观察者 C. 函数定义注释  
  13. /*!  
  14. \param observer 要添加的观察者  
  15. \see Ix_Observer  
  16. */  
  17. virtual void Attach(Ix_Observer* observer) = 0;  
  18. //! 去掉观察者  
  19. /*!  
  20. \param observer 要去掉的观察者  
  21. \see Ix_Observer  
  22. */  
  23. virtual bool Detach(Ix_Observer* observer) = 0;  
  24. //! 改变时通知所有观察者  
  25. /*!  
  26. \param data 通知参数,可为NULL  
  27. */  
  28. virtual void Notify(void* data) = 0;  
  29. };  
  30. //! 二维点结构  
  31. struct POINT2D  
  32. {  
  33. double x; //!< X坐标分量 D. 枚举/结构体/类的成员变量注视  
  34. double y; //!< Y坐标分量 在定义项右边时加“<”,在其上面一行则不加  
  35. };  
  36. //! 观察者的接口  
  37. /*! \interface Ix_Observer  
  38. */  
  39. struct Ix_Observer  
  40. {  
  41. //! 改变的通知  
  42. /*!  
  43. \param data 通知参数  
  44. \param subject 发布改变通知的出版者,其他其他其他其他  
  45. 其他其他其他其他其他其他其他其他其他  
  46. */  
  47. virtual void Update(void* data, const Ix_Subject* subject) = 0;  
  48. }; 

 

一上就是对C++ Doxygen的相关操作的介绍。

相关内容

热门资讯

如何允许远程连接到MySQL数... [[277004]]【51CTO.com快译】默认情况下,MySQL服务器仅侦听来自localhos...
如何利用交换机和端口设置来管理... 在网络管理中,总是有些人让管理员头疼。下面我们就将介绍一下一个网管员利用交换机以及端口设置等来进行D...
施耐德电气数据中心整体解决方案... 近日,全球能效管理专家施耐德电气正式启动大型体验活动“能效中国行——2012卡车巡展”,作为该活动的...
Windows恶意软件20年“... 在Windows的早期年代,病毒游走于系统之间,偶尔删除文件(但被删除的文件几乎都是可恢复的),并弹...
20个非常棒的扁平设计免费资源 Apple设备的平面图标PSD免费平板UI 平板UI套件24平图标Freen平板UI套件PSD径向平...
德国电信门户网站可实时显示全球... 德国电信周三推出一个门户网站,直观地实时提供其安装在全球各地的传感器网络检测到的网络攻击状况。该网站...
着眼MAC地址,解救无法享受D... 在安装了DHCP服务器的局域网环境中,每一台工作站在上网之前,都要先从DHCP服务器那里享受到地址动...
为啥国人偏爱 Mybatis,... 关于 SQL 和 ORM 的争论,永远都不会终止,我也一直在思考这个问题。昨天又跟群里的小伙伴进行...