doxygen windows 1.8.15 正式安装版帮助文档生成工具

doxygen windows是一款专业的帮助文档生成工具。如果你正在寻找一款好用的帮助文档生成软件你一定不能错过doxygen windows。它可以帮助您收集C ++，Objective-C，C，Java，Python，ID，PHP，C＃和D的文档。它可以从一组源文件生成HTML文件和参考手册，并且可以轻松地识别大型数据源代码。熟悉控制台应用程序的高级用户可以从命令提示符对话框中启动Doxygen，研究触发器列表并快速发送执行命令。还有一个图形界面可用，将整个任务分为两个步骤。在指定要运行Doxygen的工作目录后，您可以使用向导配置设置或进入专家模式以生成文档。在向导模式下，您可以填写与每个主题相关的信息。例如，当涉及到项目的一般细节时，您可以设置项目名称，摘要，版本/ ID和徽标，扫描源代码目录，递归模式和目标。可以为构建，消息，源浏览器，索引，HTML等选择其他选项。可以将日志详细信息保存到文件中以进行进一步检查，尤其是在发生任何错误时。

软件特色：

收集用流行的编程语言编写的项目的文档，并在自定义设置后轻松生成文件

自动生成对记录的类，文件，名称空间和成员的引用。还支持全局函数，全局变量，typedef，定义和枚举的文档

将自动生成对基类/超类和继承/重写成员的引用

包括基于快速排名的搜索引擎，用于搜索类和成员文档中的字符串或单词

您可以在文档中键入普通的HTML标签。 Doxygen将自动将它们转换为等效的LATEX，RTF和手册页副本

允许以与位置无关的方式引用为其他项目（或同一项目的其他部分）生成的文档

允许您包含自动与文档交叉引用的源代码示例

还支持包含未记录的类，从而允许快速学习（大型）代码的结构和接口，而无需查看实现细节

允许（记录的）实体自动与源代码中的定义进行交叉引用

所有源代码段均以语法突出显示，以方便阅读

允许将功能/成员/类定义包含在文档中

从易于编辑和（可选）带注释的配置文件中读取所有选项

文档和搜索引擎可以转移到其他位置或机器，而无需重新生成文档

可以轻松处理大型项目

使用说明：

Doxywizard是用于配置和运行doxygen的GUI前端。

请注意，可以使用要用作参数的配置文件来启动doxywizard。

当您启动doxywizard时，它将显示主窗口（实际外观取决于所使用的操作系统）。

主视窗

窗口显示配置和运行doxygen的步骤。第一步是选择一种配置氧的方法。

向导单击此按钮可以快速配置最重要的设置，并将其余选项保留为默认值。专家单击此按钮可以访问所有配置选项。 LoadClick此按钮可以从磁盘加载现有的配置文件。

请注意，您可以连续选择多个按钮，例如，首先使用向导配置氧气，然后通过专家微调设置。

配置doxygen后，需要将配置另存为磁盘文件。第二步允许doxygen使用该配置，并具有额外的优点，即可以在以后的某个时间点重复使用该配置以以相同的设置运行doxygen。

由于某些配置选项可能使用相对路径，因此下一步是选择运行doxygen的目录。这通常是源树的根，并且在大多数情况下已正确填充。

保存配置文件并设置工作目录后，可以根据所选设置运行doxygen。按下“开始”按钮执行此操作。 doxygen运行后，您可以再次单击同一按钮将其取消。 doxygen产生的输出被捕获并显示在日志窗口中。完成doxygen后，可以将日志另存为文本文件。

精灵直径

日志

如果您在步骤1中选择“向导”按钮，将出现一个带有多个选项卡的对话框。

向导对话框：项目设置

项目标签中的字段不言自明。完成doxygen后，可以在目标目录中找到结果。 Doxygen将每种输出格式放在单独的子目录中。

向导对话框：操作模式

模式标签可让您选择氧气在离子源上的外观。默认设置是仅查找记录的内容。

您还可以选择doxygen应如何显示结果。后者不会影响doxygen解析源代码的方式。

向导对话框：输出生成

您可以选择doxygen应该生成的一种或多种输出格式。对于HTML和$ \ mbox {\ LaTeX} $，还有其他选项。

向导对话框：生成的图表

Doxygen可以生成许多图表。使用“图表”选项卡，可以选择要生成的项目。对于大多数图形，需要GraphViz软件包的Point工具。

专家对话框

“专家”对话框具有许多选项卡字段，其中一个对应于配置文件中的每个部分。每个选项卡字段都包含多行，并且此部分用于此部分中的每个配置选项。

输入窗口小部件的类型取决于配置选项的类型。

•对于每个布尔选项（在配置文件中以“是”或“否”回答的选项），都有一个复选框。

•对于使用固定值集的项目（例如OUTPUT_LANGUAGE），将使用组合框。

•对于从范围中取整数值的项目，请使用旋转框。

•对于自由格式的字符串类型选项，有一行编辑字段

•要获取字符串列表的选项，可以使用单行编辑字段，使用“ +”按钮将此字符串添加到列表中，然后使用“-”按钮从列表中删除选定的字符串。还有一个“ *”按钮，它将用在编辑字段中输入的字符串替换列表中的所选项目。

•对于文件和文件夹条目，有一些特殊按钮可启动文件选择对话框。

专家对话框中的一些选项

有关选项含义的其他信息，请单击对话框右下角的“帮助”按钮，然后单击该项目。将显示带有其他信息的工具提示。

菜单选项

GUI前端有一个包含几个有用项的菜单

文件菜单

打开...这与主窗口中的“加载”按钮相同，允许从磁盘打开配置文件。另存为...这与主窗口中的“保存”按钮相同，可用于将当前配置设置保存到磁盘。最近的配置允许快速加载最近保存的配置。设置为默认值...将当前配置设置存储为下次启动GUI时要使用的默认设置。系统将要求您确认操作。重置...将出厂默认设置恢复为要使用的默认设置。系统将要求您确认操作。

软件特色：

•跨平台：适用于Windows和许多Unix样式（包括Linux和MacOSX）。

•索引，组织和生成可浏览和交叉引用的输出，甚至来自未记录的代码。

•为解析的源生成结构化的XML输出，可以由外部工具使用。

•支持C / C ++，Java，（Corba和Microsoft）Java，Python，VHDL，PHP IDL，C＃，Fortran，TCL，Objective-C 2.0和某种程度上的D源。

•支持文件，名称空间，程序包，类，结构，联合，模板，变量，函数，typedef，枚举和定义。

•与JavaDoc（1.1），qdoc3（部分）和ECMA-334（C＃规范）兼容。

•包含GUI前端（Doxywizard），以简化编辑选项并运行doxygen。该GUI在Windows，Linux和MacOSX上可用。

•自动生成HTML（作为可单击的图像映射）和$ \ mbox {\ LaTeX} $（作为封装的PostScript图像）类和协作图。

•使用Graphviz工具包生成依赖关系图，协作图，调用图，目录结构图和图类层次图。

•允许对模块中的实体进行分组并创建模块层次结构。

•灵活的注释放置：允许您将文档放置在头文件（在实体声明之前），源文件（在实体定义之前）或单独的文件中。

•生成类的所有成员（包括任何继承的成员）及其保护级别的列表。

•以联机格式（XHTML和UNIX手册页）和脱机格式（$ \ mbox {\ LaTeX} $和RTF）输出文档（如果需要，可以禁用其中的任何一个）。所有格式均经过优化，易于阅读。

此外，您可以使用Microsoft的HTML帮助工作室（仅Windows）从HTML输出生成压缩的HTML，还可以从$ \ mbox {\ LaTeX} $输出生成PDF。

•支持各种第三方帮助格式，包括HTML帮助，docset，Qt-Help和eclipse帮助。

•包括完整的C预处理程序，以允许对条件代码片段进行正确的解析，并扩展全部或部分宏定义。

•自动检测公共，受保护和私有部分，以及Qt特定的信号和插槽部分。提取私有类成员是可选的。

•自动生成对文档类，文件，名称空间和成员的引用。还支持全局函数，全局变量，typedef，定义和枚举的文档。

•自动生成对基类/超类的引用以及继承/重写成员。

•包括一个基于快速排名的搜索引擎，用于搜索类和成员文档（基于PHP）中的字符串或单词。

•包括基于Javascript的实时搜索功能，您可以在键入时搜索符号（适用于中小型项目）。

•您可以在文档中键入普通的HTML标签。 Doxygen将自动将它们转换为等效的$ \ mbox {\ LaTeX} $，RTF和手册页。

•允许以与位置无关的方式引用为其他项目（由doxygen记录）生成的文档（或同一项目的其他部分）。

•允许包含与文档自动交叉引用的源代码示例。

•还支持包含未记录的类，从而可以快速学习（大型）代码的结构和接口，而无需查看实现细节。

•允许对（记录的）实体与源代码中的定义进行自动交叉引用。

•所有源代码段均以语法突出显示，以方便阅读。

•允许功能/成员/类定义包含在文档中。

•从易于编辑的（可选）带注释的配置文件中读取所有选项。

•文档和搜索引擎可以转移到其他位置或mac

隐藏而不重新生成文档。

•支持许多不同的字符编码，并在内部使用UTF-8和生成的输出。

•Doxygen可以生成布局，您可以使用和编辑布局来更改每个页面的布局。

•有100多个可配置选项可微调输出。

•可以轻松处理大型项目。

安装方式：

1.下载并解压缩软件，双击安装程序以进入doxygen安装向导，然后单击[下一步]按钮。

2.阅读软件许可协议，选中[我接受协议]选项，然后进入下一步安装。

3.选择安装位置。用户可以选择默认安装路径或对其进行自定义。

4.选择安装组件，通常选择默认的全部安装。

5.选择开始菜单文件夹，用户可以选择默认的氧气。

6.要准备安装，请单击[安装]按钮开始安装。

7.弹出以下信息界面，单击[下一步]按钮继续。

8.完成安装，单击[完成]以结束安装。