Win7下Doxygen配置与使用

article/2025/9/27 20:51:31

1.  下载与安装

1.1 下载

Doxygen官方安装程序及其手册下载地址,目前使用版本为1.8.8。

安装程序:http://www.stack.nl/~dimitri/doxygen/download.html

图 1-1 Doxygen安装程序下载界面

在线帮助:http://www.stack.nl/~dimitri/doxygen/manual

图 1-2 Doxygen帮助文档下载界面

GraphViz Doxygen官方安装下载地址及其在线帮助地址,目前使用版本为2.38。

安装程序:http://www.graphviz.org/pub/graphviz/stable/windows/

图 1-3 GraphViz安装程序下载界面

在线帮助:http://www.graphviz.org/Documentation.php

图 1-4 GraphViz在线帮助界面

1.2 安装

以上两个安装程序可以任意安装,但是一定要记住Graphviz的安装路径,Doxygen的设置中要使用此路径以生成调用关系图。

2.  Doxygen配置与使用

2.1 基础配置

Doxygen的配置向导可以完成项目路径、工作模式、输出文档、图片工具四个方面的简要配置。

在图2-1中展示了项目路径配置的相关内容:其一,可以设置项目的名称、概述、版本号和项目标志;其二,可以设置源代码所在路径,递归扫描指是否将子文件夹加入源码搜索路径;其三,可以设置代码文档的输出路径,html、rtf等不同格式的代码文档以相应的文件夹存储在此路径之下。

图 2-1 项目配置

在图2-2所示的工作模式配置中,可以设定代码文档中的内容,即包括所有实体还是仅包括标记的实体。除此之外,还要手动选择Doxygen的运行时优化方案,这里选择了针对C语言和PHP的优化选项。

图 2-2 工作模式配置

在图2-3中,选择了输出HTML和RTF格式的代码文档,其中还可以设置HTML代码文档的输出内容,包括纯HTML文档、左侧带有导航树的HTML文档以及CHM文件支持,还可以更改HTML文档的配色方案。

图 2-3 输出代码文档设置

在图2-4所示的界面中,可以自由设置输出文档中是否含有图片、使用Doxygen内置图片工具生成图片、使用GraphViz生成图片三种方式。

图 2-4 图片工具设置

2.2 高级配置

高级配置是对基础配置的进一步细化,以形成不同风格的注释文档。由于涉及参数较多,本文并未给出所有参数的说明,这里仅介绍重要的参数,未尽部分还请读者自行阅读窗口左侧靠下的参数说明(详见图 25左侧红色矩形框所标识的区域)。

图2-5~图2-7完成了项目的详细配置,请注意输出语言一定要选择Chinese,一定要勾选图2-6中的JAVADOC_AUTOBRIEF选项和图2-7中的MARKDOWN_SUPPORT、AUTOLINK_SUPPORT选项,依次表示支持JavaDoc风格注释、Markdown标记方法、注释实体自动链接三种功能。

图 2-5 项目配置一

图 2-6 项目配置二

图 2-7 项目配置三

图2-8中则展示了Doxygen运行时所抽取的内容,一般采用默认设置,也可结合需求根据参数说明自行修改。

图 2-8 代码文档中包含的内容

在图2-9中,用户可以自定义Doxygen的运行日志所显示的内容与方式,可以通过运行日志检查注释的正误。

图 2-9 Doxygen运行日志的显示内容和格式

图2-10和图2-11依次说明了源码搜索路径、示例代码搜索路径和外部图片搜索路径的设置,这里一定要注意源码的编码格式设置为GBK。一旦文件编码格式有误,代码文档中就会出现乱码。

图 2-10 输入设置一——源码路径与编码格式

图 2-11 输入设置二——示例代码和图片的搜索设置

可以通过图2-12实现代码文档与源文件之间的交叉引用,方便阅读,一般使用默认设置。

图 212 源码与文档交叉引用设置

利用图2-13中索引方法设置,可以实现代码文档中的各注释对象的出现顺序,即按照字母顺序或者先后顺序显示。

图 2-13 索引方法设置

图2-14和图2-15分别展示了HTML文档、CHM文档的设置方法,其中CHM文档的生成需要HHC编译器,一般的路径为C:\Program Files\HTML Help Workshop。

图 2-14 HTML文档设置

图 2-15 CHM文档设置

代码的RTF文档设置如图图2-16,如果是小型项目最好勾选COMPACT_RTF选项,据说可以使得文档更紧凑。如果选中RTF_HYPERLINKS选项,则在RTF文档中会以链接的形式显示注释的对象。另外,如果RTF文档中的页码不能正常显示,请使用WORD中的更新域的命令更新文档即可。

图 2-16 RTF文档设置

通过图2-17所示的界面,在选择了GraphViz的路径之后,可以设置GraphViz生成图片的种类。

图 2-17 GraphViz的图片选项和路径设置

至此,已经完成Doxygen的所有设置,可以利用【File】和【Settings】菜单保存现有设置、导入已有配置等功能。

2.3 运行Doxygen

Doxygen的运行界面如图2-18所示,可以在该界面生成代码文档、显示结果和配置文件、保存日志等功能。

图 2-18 Doxygen的运行界面

请注意,如果Doxygen的运行窗口出现错误或者警告,请仔细阅读并找出问题所在,修改注释后即可。

另外,再次申明:如果RTF文档中不能正确显示页码,请对整篇文档使用"更新域"操作。

转载于:https://www.cnblogs.com/hblflu/p/4121723.html


http://chatgpt.dhexx.cn/article/DjAgCFCt.shtml

相关文章

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年双十一业务安全保卫战-某厂第一名,某厂特邀数字业务安全研究员&…

thinkphp框架的使用

ThinkPhp知识大全(非常详细) 转载文章,感觉写的非常好 thinkphp.cn thinkphp 3.2版本 【框架项目部署】 部署一个Shop项目,使用tp框架 步骤: 创建入口文件: 1.在ThinkPHP目录下创建一个入口文件index.…

PHP之ThinkPHP框架

一、框架概述 1、什么是框架 框架就是一些代码类、方法(函数)、变量、常量的集合,这些代码是功能结构性的代码(并非业务代码)。业务代码其实就是具体的一些模块的增删改查逻辑代码。 使用框架开发项目,有…

ThinkPHP框架之快速入门

一.创建工程tp&#xff0c;目录结构如下: 在工程下导入thinkphp。 在tp中&#xff0c;可以在任何目录下创建入口文件&#xff0c;也可以把项目初始化到任何目录下. index.php: <?php //定义thindphp的路径 define(THINK_PATH, ./ThinkPHP/); //默认值当前目录下的./Thi…

PHP_thinkPHP框架(1)

能够理解并使用composer PHP一个包管工具 解决源码包 依赖问题 ​ 1.7.3 软件升级 composer self-update 能够安装Thinkphp5.1框架 composer create-project --prefer-dist topthink/think[版本号] 目录名称 ​ 安装之前一定要切换国内源&#xff0c;否则成功的概率很小。 …