Doxygen 使用总结,生成chm文件,附:配置文件Doxyfile

  1. win系统下,doxygen软件下载和安装
    doxygen-1.8.14-setup.exe
    协调使用的软件下载和配置:
    graphviz-2.38.msi——生成调用关系图
    htmlhelp.exe——生成chm文件(可选)

    详见《文档生成工具-Doxygen使用方法以及注释规则》
    《Win7下Doxygen配置与使用》

  2. 打开软件

  3. 准备工作文件夹
    1)新建文件夹,该文件夹包含:
    ①doxyfile——配置文件,附件:C/C++配置文件Doxyfile
    ②project_code——源码文件夹,将需要生成的源代码文件拷贝至该文件夹下即可;
    ③DoxyOutput——输出文件夹,保存Doxygen生成的所有文件;
    在这里插入图片描述

  4. 打开Doxygen软件,点击file —>open—>上一步所建文件夹中的Doxyfile配置文件(D:\Program Files (x86)\doxygen\2020-04-01\Doxyfile),此时Doxygen软件界面如下:
    在这里插入图片描述
    说明:配置文件在doxygen软件打开后,就自动生成了。你在界面中填写后,会自动修改,然后save as保存。

Mode中可修改语言类型,支持:C、C++、C#、Java等

其它详细配置参考:https://blog.csdn.net/weixin_42465158/article/details/114838506

  1. 附件的配置文件中,已经配置了HTML、DOT,用于生成调用关系图、chm文件,如下:
    在这里插入图片描述
    在这里插入图片描述
    1)htmlhelp下载:http://msdn.microsoft.com/en-us/library/ms669985.aspx
    Doxygen自动生成chm,需下载HTML Help Workshop,我们将要使用当中的hcc.exe文件以及相关dll。
    2)Graphviz下载:http://www.graphviz.org/download/
    graphviz 是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图,如不需要此功能可不安装该工具包。

  2. 代码注释
    Doxygen 可以从源代码中提取消息生成帮助文档,它是根据源代码中的特定注释来实现。所以,首先要给工程代码书写符合Doxygen格式的注释。
    见博客:《Doxygen简明注释语法》
    《doxygen的文档生成,注释规范 》

  3. linux安装及使用手册
    详见百度文档:《doxygen配置及使用手册 》

注:*.chm 目录为乱码,应将下图 UTF-8改改为GB2312
在这里插入图片描述

  • 5
    点赞
  • 17
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
Doxygen是一款流行的代码文档生成工具,它可以从源代码中自动生成详细和易于阅读的文档。下面是使用Doxygen的简单教程: 1. 安装Doxygen:首先,你需要从Doxygen的官方网站(https://www.doxygen.nl/)下载并安装Doxygen。根据你的操作系统选择合适的版本进行安装。 2. 创建配置文件:在你的项目根目录下创建一个名为`Doxyfile`的配置文件。可以使用以下命令生成默认的配置文件: ``` doxygen -g Doxyfile ``` 3. 配置文件设置:打开`Doxyfile`配置文件,在其中可以修改一些选项以满足你的需求。以下是一些常用的配置选项: - `PROJECT_NAME`:设置项目的名称。 - `INPUT`:指定要生成文档的源代码目录或文件。 - `OUTPUT_DIRECTORY`:指定生成的文档输出目录。 - `EXTRACT_ALL`:设置为`YES`以提取所有文档,包括没有注释的。 - `GENERATE_HTML`:设置为`YES`以生成HTML格式的文档。 - `GENERATE_LATEX`:设置为`YES`以生成LaTeX格式的文档。 4. 生成文档:运行以下命令来生成文档: ``` doxygen Doxyfile ``` 5. 查看文档:完成上述步骤后,Doxygen将会在指定的输出目录中生成文档。你可以在浏览器中打开生成的HTML文件来查看文档。 这只是一个简单的Doxygen教程,Doxygen还提供了更多高级配置选项和功能,如自定义模板、图形化界面等。你可以参考Doxygen的官方文档以获取更详细的信息和进一步的学习资源。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值