C++ Doxygen实现功能分享

开发 后端
C++ Doxygen主要可以为我们实现文档化代码注释的自动才生成。那么接下来就让我们一起来看看这方面技巧应用的具体操作方法。

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的相关操作的介绍。

责任编辑:曹凯 来源: 博客园
相关推荐

2010-02-05 16:25:10

C++ strtok(

2010-02-03 15:52:55

C++ clock()

2010-01-11 11:02:59

Visual C++

2024-01-31 08:33:06

C++编程计算器

2010-02-04 11:38:43

C++获取当前路径

2010-02-01 11:13:00

C++ Traits

2011-07-13 16:36:11

C++

2011-07-13 17:42:32

CC++

2011-07-13 16:48:55

CC++

2011-07-13 17:08:02

CC++

2010-02-06 13:47:08

C++标准扩展

2010-02-03 13:22:07

C++时间

2011-07-01 10:16:08

C++内存管理

2010-02-04 14:58:06

C++内存分配

2023-10-30 10:29:50

C++最小二乘法

2010-02-04 15:19:38

C++获取CPU信息

2014-04-04 09:53:18

2048C++

2010-01-27 18:06:03

Android短信发送

2016-08-11 08:24:39

AndroidIntentShareTestDe

2010-02-01 17:09:07

C++链表操作
点赞
收藏

51CTO技术栈公众号