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

article/2025/9/27 19:05:12
  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
在这里插入图片描述


http://chatgpt.dhexx.cn/article/4h3QqMJf.shtml

相关文章

Doxygen生成.chm文件

Doxygen生成.chm文件 目录 Doxygen生成.chm文件安装准备Doxygen Gui使用Wizard设置project设置Mode设置Output设置Diagrams设置 Expert设置Project设置Input设置HTML设置Dot设置 Run运行生成 总结 安装准备 1、doxygenGUI 下载地址:Doxygen: Downloads 2、HTML He…

doxygen 教程 linux,使用Doxygen生成全中文的chm、pdf帮助文档的方法

下载和安装 Doxygen 到 Doxygen 官网 下载最新的Doxygen安装程序,然后安装。这个软件包包括了一个GUI界面的前端工具,可以帮助我们方便创建Doxygen配置文件和生成目标文档。 软件名称:帮助文档生成器( doxygen ) 1.8.13 官方最新英文安装版(附帮助文档)软件大小:21.7KB更新…

Doxygen (1): 安装及设置

文章目录 0. 前言1. 下载1.1 graphviz1.2 Microsoft HTML Help Workshop1.3 Doxygen 2. 安装3. 配置3.1 Wizard3.1.1 Project3.1.2 Mode3.1.3 Output3.1.4 Diagrams 3.2 Expert3.2.1 Project3.2.2 Build3.2.3 Input3.2.4 HTML3.2.5 Dot 3.3 保存配置信息 0. 前言 使用 doxygen …

Win7下Doxygen配置与使用

1. 下载与安装 1.1 下载 Doxygen官方安装程序及其手册下载地址,目前使用版本为1.8.8。 安装程序:http://www.stack.nl/~dimitri/doxygen/download.html 图 1-1 Doxygen安装程序下载界面 在线帮助:http://www.stack.nl/~dimitri/doxygen/m…

Doxygen使用教程

Doxygen 可以用来为项目生成帮助文档或者 SDK,输出格式可以为 HTML、CHM 等。 1 软件安装 doxygen-1.9.1-setup.exestable_windows_10_cmake_Release_x64_graphviz-install-2.47.3-win64.exehtmlhelp.exe 2 Doxygen 注释规范 2.1 注释格式 # 块注释 /** ...... …

doxygen: 在Windows上源码编译

文章目录 1. 目的2. 思路3. 安装 Chocolatey4. 用 choco 安装 bison 和 flex安装 gs:安装 libiconv 5. 编译报错 1. 目的 在 windows 上源码编译 doxygen, 改代码加功能。 2. 思路 doxygen 依赖 flex 和 bison, 手动编译 flex 和 bison 很麻烦可以用…

Doxygen安装与基本配置

Doxygen最初是一个C的源码文档生成成器,现在也支持像C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl等语言,可以方便生成源码文档,配合Graphviz可以清晰地生成函数和类的对…

20_doxygen:win下vscode自动注释、生成doc

文章目录 1.结果如图2.win2.1设置目录2.2设置源码语言2.3设置输出doc2.4设置Graphviz路径2.5运行,生成doc 3.VScode3.1注释自动补全3.2生成doc 参考 如仅需要VScode注释自动补全,跳转至 3.1注释自动补全 1.结果如图 自动注释 生成doc 2.win 安装doxy…

在Win上学习使用Doxygen与GraphViz

安装 Doxygen官方下载 Graphviz Win上的最新版本 截止2018-04-06 Graphviz最新版本是2.38Doxygen最新新版是1.8.14 因为不想分心处理安装后的环境变量配置,所以都选择了可执行包。一路“确定”就安装好了。 使用 参考资料:【1】 使用Doxygen自带…

Doxygen、hhc生成chm格式文档

开源库中很多帮助文档是html格式,需要通过Doxgen生成 生成后有一系列文件,再通过hhc.exe打包成chm,就能方便拷贝到移动设备查看,比如IOS的chm sharp 下载Doxygen https://www.doxygen.nl/download.html 只需要下载其中的 binarie…

win10环境搭建

1、clion安装与配置 配置编译环境MinGW 解压MinGW.zip文件夹,配置环境变量:此电脑–>属性–>高级系统变量–>环境变量–>path D:\Program_Files\mingw64\bin安装clion 双击clion.exe文件安装,安装后将jetbrains-agent.jar文件复制到clio…

Win10+vs2017+OpenCV3.4.1+doxygen+cmake安装(DEBUG64位)

下载软件 软件:vs2017 网址:https://visualstudio.microsoft.com/zh-hans/vs/whatsnew/ 软件:opencv-3.4.1 网址:https://opencv.org/releases.html 软件:cmake-3.11(下载解压版本即可) …

Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE)

Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE) 使用cmake .. 有时候会遇到如下问题: $ cmake ..-- The CXX compiler identification is GNU 11.2.0 -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Check for worki…

win10系统msmq服务器,win10使用RabbitMQ实现消息队列

熟悉了 linux 下使用消息队列实现进程异步,转到 win10 下该怎么办? RabbitMQ 简介 可靠性(Reliability):RabbitMQ 使用一些机制来保证可靠性,如持久化、传输确认、发布确认。 灵活的路由(Flexible Routing):在消息进入队列之前,通过 Exchange 来路由消息的。对于典型的路由…

ThinkPHP框架漏洞总结

Thinkphp简介 ThinkPHP是为了简化企业级应用开发和敏捷WEB应用开发而诞生的,是一个快速、兼容而且简单的轻量级国产PHP开发框架,诞生于2006年初,原名FCS,2007年元旦正式更名为ThinkPHP,遵循Apache2开源协议发布&#…

Thinkphp5框架简单理解

说明 该文章来源于同事lu2ker转载至此处,更多文章可参考:https://github.com/lu2ker/ 目录 说明TP5框架简单理解1. 架构总览1.1 控制器/操作1.2 MVC模式流程1.3 类库自动加载1.4 URL访问检测1.5 路由模式1.5.1 普通模式1.5.2 混合模式1.5.4 强制路由 1.…

ThinkPHP框架-2

十、ThinkPHP框架中的模型 模型的作用、处理业务数据、与数据库进行交互。 1、导入数据表 新建tpshop数据库(create database tpshop character set utf8 collate utf8_general_ci) 导入数据表 说明:如果导入sql文件时,有报错,提示类似“…

ThinkPHP框架介绍及应用

一.ThinkPHP介绍 1.1.什么是框架 PHP框架是许多代码的集合,这些代码是程序结构的代码(并不是业务代码),代码中有许多函数、类、功能类包,框架的代码按照一定标准组成了一个有机的功能体,这个功能体中有许多设计模式如MVC、单例、…

thinkPHP框架学习(速成,一天)

一。TP框架介绍与配置 第一个是最开始沿用的一种结构,它有一个致命的缺点:比如说如果后端程序员在编写的过程中,前端程序就不能做修改,一旦修改了,那么肯定会有冲突。 后来大家进行了改进----把前端脱离出来。 再后来…

【代码审计-PHP】基于Thinkphp框架开发的

前言: 介绍: 博主:网络安全领域狂热爱好者(承诺在CSDN永久无偿分享文章)。 殊荣:CSDN网络安全领域优质创作者,2022年双十一业务安全保卫战-某厂第一名,某厂特邀数字业务安全研究员&…