C++Doxygen实现功能分享

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

成都创新互联公司专注于企业全网整合营销推广、网站重做改版、保德网站定制设计、自适应品牌网站建设、H5场景定制、商城开发、集团公司官网建设、成都外贸网站制作、高端网站制作、响应式网页设计等建站业务，价格优惠性价比高，为保德等各大城市提供网站开发制作服务。

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

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

当前文章：C++Doxygen实现功能分享
文章地址：http://www.hantingmc.com/qtweb/news30/216330.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

网站维护知识

分类信息网

营销型网站建设　　 　网站推广　　 　成都圣月服饰　　 　SSL证书　　 　雷运建站　　 　手机网站制作　　 　德阳服务器托管　　 　企业网站设计　　 　微信公众号二次开发　　 　重庆电信五里店机房　　 　四川乐山服务器托管　　 　定制网站制作　　 　成都建网站　　 　四川正泰动物　　 　眉山做网站　　 　成都微信小程序开发　　 　四川成都网站制作　　 　成都网站设计　　 　服务器托管　　 　手提袋印刷制作