文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

C++中怎么利用Doxygen实现一个分享功能

2023-06-17 16:18

关注

这篇文章给大家介绍C++中怎么利用Doxygen实现一个分享功能,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。

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

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

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

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

安装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. 成员变量的注释,如果注释写在变量右边,则加“<”,例如//!< &hellip;&hellip;

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

//! \file Ix_Observer.h A. 文件头注释,用于在帮助文件中列出文件列表  //! \brief 定义出版者和观察者的接口Ix_Subject、Ix_Observer  #pragma once  struct Ix_Subject;  struct Ix_Observer;  //! 出版者的接口 B. 类/结构体等的定义注释    struct Ix_Subject  {  //! 添加观察者 C. 函数定义注释    virtual void Attach(Ix_Observer* observer) = 0;  //! 去掉观察者    virtual bool Detach(Ix_Observer* observer) = 0;  //! 改变时通知所有观察者    virtual void Notify(void* data) = 0;  };  //! 二维点结构  struct POINT2D  {  double x; //!< X坐标分量 D. 枚举/结构体/类的成员变量注视  double y; //!< Y坐标分量 在定义项右边时加“<”,在其上面一行则不加  };  //! 观察者的接口    struct Ix_Observer  {  //! 改变的通知    virtual void Update(void* data, const Ix_Subject* subject) = 0;  };

关于C++中怎么利用Doxygen实现一个分享功能就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯