Doxygen软件截图
Doxygen软件简介
Doxygen是一款开源跨平台、类似JavaDoc风格的文档系统。全面支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C。
软件优点
?跨平台:doxygen windows官方版适用于Windows和许多Unix风格(包括Linux和MacOSX)。
?索引,组织并生成可浏览和交叉引用的输出,甚至来自未记录的代码。
?为解析的源生成结构化XML输出,可由外部工具使用。
?doxygen windows官方版支持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}$(作为Encapsulated PostScript图像)的类和协作图。
?使用Graphviz工具包的点工具生成包含依赖关系图,协作图,调用图,目录结构图和图形类层次结构图。
?允许在模块中对实体进行分组并创建模块层次结构。
?灵活的注释放置:允许您将文档放在头文件中(在实体声明之前),源文件(在实体定义之前)或单独的文件中。
?生成类的所有成员(包括任何继承的成员)及其保护级别的列表。
?同时以在线格式(XHTML和UNIX手册页)和离线格式($mbox{LaTeX}$和RTF)输出文档(如果需要,可以禁用其中任何一个)。所有格式都经过优化,易于阅读。
此外,可以使用Microsoft的HTML Help Workshop(仅限Windows)从HTML输出生成压缩HTML,并且可以从$mbox{LaTeX}$输出生成PDF。
?支持各种第三方帮助格式,包括HTML帮助,docset,Qt-Help和eclipse帮助。
?包括完整的C预处理器,以允许正确解析条件代码片段并允许扩展全部或部分宏定义。
?自动检测公共,受保护和私有部分,以及Qt特定信号和插槽部分。提取私有类成员是可选的。
?自动生成对文档类,文件,名称空间和成员的引用。还支持全局函数,全局变量,typedef,定义和枚举的文档。
?自动生成对基类/超类和继承/重写成员的引用。
?包括一个基于排名的快速搜索引擎,用于搜索类和成员文档中的字符串或单词(基于PHP)。
?包括基于Javascript的实时搜索功能,可在您键入时搜索符号(适用于中小型项目)。
?您可以在文档中键入普通的HTML标记。Doxygen会自动将它们转换为等效的$mbox{LaTeX}$,RTF和man-page对应物。
?允许以独立于位置的方式引用为其他(doxygen记录的)项目(或同一项目的其他部分)生成的文档。
?允许包含与文档自动交叉引用的源代码示例。
?还支持包含未记录的类,允许快速学习(大)代码的结构和接口,而无需查看实现细节。
?允许(记录的)实体与源代码中的定义自动交叉引用。
?所有源代码片段都以语法突出显示,以便于阅读。
?允许在文档中包含函数/成员/类定义。
?从易于编辑和(可选)带注释的配置文件中读取所有选项。
?文档和搜索引擎可以转移到其他位置或机器,而无需重新生成文档。
?支持许多不同的字符编码,并在内部使用UTF-8和生成的输出。
?Doxygen可以生成一个布局,您可以使用和编辑该布局来更改每个页面的布局。
?有超过100个可配置的选项可以微调输出。
?可以轻松应对大型项目。
软件特性
收集用流行编程语言编写的项目的文档,并在自定义设置后轻松生成文件
自动生成对记录的类,文件,名称空间和成员的引用。还支持全局函数,全局变量,typedef,定义和枚举的文档
将自动生成对基类/超类和继承/重写成员的引用
包括一个基于排名的快速搜索引擎,用于搜索类和成员文档中的字符串或单词
您可以在文档中键入普通的HTML标记。Doxygen会自动将它们转换为等效的LATEX,RTF和man-page对应物
允许以独立于位置的方式引用为其他项目(或同一项目的其他部分)生成的文档
允许包含与文档自动交叉引用的源代码示例
还支持包含未记录的类,允许快速学习(大)代码的结构和接口,而无需查看实现细节
允许(记录的)实体与源代码中的定义自动交叉引用
所有源代码片段都以语法突出显示,以便于阅读
允许在文档中包含函数/成员/类定义
从易于编辑和(可选)带注释的配置文件中读取所有选项
文档和搜索引擎可以转移到其他位置或机器,而无需重新生成文档
可以轻松应对大型项目
安装步骤
1.doxygen的安装非常简单。在linux下,您可以直接下载安装包并运行它。下载源代码、编译和安装也是编译和安装的常用命令。
2.生成文档时,可以在文档生成过程中定义项目属性和许多选项。您可以使用以下命令生成默认配置文件:doxygen-g[配置文件名]
3.配置文件中对应的项目可以根据项目的具体要求进行修改,修改后的配置文件可以作为以后项目的模板。
4.让软件自动生成文档,但是平时的标注风格不行,需要按照自己的格式。
5.好了,代码写完了,评论按照格式写。最后的文件是什么?很简单,运行下面的命令,就会在指定的目录下生成相应的文档:doxygen[配置文件名]
6.需要注意的是,doxygen并不处理所有的注释,而是侧重于与程序结构相关的注释,比如文件、类、结构、函数、变量和宏的注释,而忽略了函数内变量和代码的注释。