doxygen的使用说明12 - 说明文书.docxVIP

介绍Doxygen关于此两个方面的用法。相关详细的配置教程网上有很多也很容易，所以这里就不再赘述，如已生成的chm文件。如果想修

介绍Doxygen关于此两个方面的用法。相关详细的配置教程网上有很多也很容易，所以这里就不再赘述，如

已生成的chm文件。如果想修

择open，选择你将Doxyfile配置文件所放的路径，找到doxyfile配置文件，然后打开，你的

一、安装Doxygen所需工具

经我安装测试推荐如下软件版本：

软件

软件Doxygen

版本1.8.6

Graphviziconvfr

2.281.9.22.1.1

HTMLHelpWorkshop

4.74

注：HTMLHelpWorkshop工具要安装在这个路径“X:\ProgramFiles\HTMLHelpWorkshop”（X：自己指定）。

二、附带操作

为了方便运行Doxygen工具与管理，为每个模块创建一文件夹，我将此文件夹命名为Test，在Test文件夹里再创建src和doc文件夹。Src文件夹主要存放源文件，doc文件夹主要放置Doxygen输出文件。

注：Doxygen不支持中文路径，所以路径中不要出现中文字符。

三、配置Doxygen

Doxygen中有很多详细的功能，很多是不需要的，因为我们接触的一般是C++和C所以我主要介绍Doxygen关于此两个方面的用法。

相关详细的配置教程网上有很多也很容易，所以这里就不再赘述，如下文件doxygen-1.8.6-setup\Test\doc\Doxyfile是我的一个配置文件，可以直接放到Test文件下的doc文件里，用户只需打开这个配置文件就完成了Doxygen的配置。如果只为C和C++做注释时，只需

的配置，方便下次调用。四、Doxygen的使用在Step1中选择保存源代码的文件夹，然后单击

的配置，方便下次调用。四、Doxygen的使用在Step1中选择保存源代码的文件夹，然后单击run选

可以直接放到Test文件下的doc文件里，用户只需打开这个配置文件就完成了Doxygen的配置。如果

项，Doxygen开始工作，提示完成后可以打开HTML发现注释文件就以网页形式呈现，在输出目录里找到

xygenDoxygen中有很多详细的功能，很多是不需要的，因为我们接触的一般是C++和C所以我主要

首先打开Doxygen，如下图所示：

单击File项选择open，选择你将Doxyfile配置文件所放的路径，找到doxyfile配置文件，然后打开，你的Doxygen就完成了基本的配置，不过有几处需要修改，下面我详细介绍下：

Projectname:项目名称，将作为所生成的程序文档首页标题

Projectversionorid:文档版本号和可对应项目版本号

Sourcecodedirectory:存放要生成项目文档的项目源文件路径，推荐放到已建立的Src文件里

Destinationdirectory：生成文档输出路径，我设置的是输出到桌面的

用到其它语言则选择相应的选项。单击Expert，只需单击HTML选项，如下图所示：如果不想生成chm的配置，方便下次调用。四、Doxygen的使用在Step1中选择保存源代码的文件夹，然后单击

用到其它语言则选择相应的选项。单击Expert，只需单击HTML选项，如下图所示：如果不想生成chm

的配置，方便下次调用。四、Doxygen的使用在Step1中选择保存源代码的文件夹，然后单击run选

/，其它的部分不推荐改动，这样就完成了Doxygen的各项配置了，单击file文件保存Doxygen

只为C和C++做注释时，只需修修改如下内容即可。首先打开Doxygen，如下图所示：单击File项选

单击Mode选项，如图所示：

如果只用到C++则不需改动，如用到其它语言则选择相应的选项。单击Expert，只需单击HTML选项，如下图所示：

下文件doxygen-1.8.6-setup\Test\doc\Doxyfile是我的一个配置文件，xygenDoxygen中有很多详细的功能，很多是不需要的，因为我们接触的一般是

下文件doxygen-1.8.6-setup\Test\doc\Doxyfile是我的一个配置文件，

xygenDoxygen中有很多详细的功能，很多是不需要的，因为我们接触的一般是C++和C所以我主要

号Sourcecodedirectory:存放要生成项目文档的项目源文件路径，推荐放到已建立的Src

只为C和C++做注释时，只需修修改如下内容即可