使用Doxygen构建文档系统
2008-01-05 17:57:51 来源:WEB开发网假如您这次还没来得及使用老式的Help Workshop为您的Web应用构建文档系统的话,那么,何不尝试一下Doxygen,需知"The PRoof of the pudding lies in the eating"。
Doxygen是什么?
Doxygen是一种开源跨平台的,以类似javaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持php、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成Html格式的在线类浏览器,或离线的LATEX、RTF参考手册。对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依靠图(include dependency graphs)、继续图(inheritance diagram)以及协作图(collaboration diagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unix man page等。
Doxygen在linux上开发,但也可以在其它的Unix平台下运行。而且,Windows 9x/NT平台下也有对应的可执行版本。
安装Doxygen
首先,去Doxygen网站上找到最新版本的Doxygen。有二进制或源码两种版本,假如不想重头编译,下载二进制版本安装即可。在Linux下,源码编译需要perl和Gnu工具flex、bison、make的支持。在Windows下,二进制版本勿需安装,而源码编译所需支持工具较多。我们仅讲述Linux下的Doxygen的源码编译以及二进制版本安装过程。
编译源码
gunzip doxygen-$VERSION.src.tar.gz tar xf doxygen-$VERSION.src.tar sh ./configure,或者configure --platform platform-type (略去直接使用configure需要平台检测的过程,平台类型在PLATFORMS文件中列出), configure --with-doxywizard(GUI前端选项) make,或者make docs(创建HTML格式的手册),make pdf(创建PDF格式的手册)
安装二进制版本
./configure make install
二进制文件安装目录是<prefix>/bin,其中<prefix>缺省为/usr,可以通过configure的参数--prefix修改其值。使用make install_docs可以把文档和例子安装在目录<docdir>/doxygen,其中<docdir>缺省为<prefix>/share/doc/packages,可以通过configure的参数--docdir修改其值。doxygen是bin目录下的一个命令行程序,它是Doxygen的核心工具,完成文档的转换和生成工作。
Doxygen的处理流程
图1是Doxygen网站上给出的Doxygen处理工具以及它们之间的信息流。
从图中可以看出,Doxygen可执行程序位于正中,所有的流程都围绕着它进行。左侧图标表示Doxygen的输入可以是源文件,或者是定制的头文件、图像、注解等。Doxygen图标上部是配置文件,由Doxywizard处理,下部是Tag文件,由Doxytag处理。后面是Doxygen输出文件的类型,依次是xml、Latex、Man pages、RTF和HTML,可处理类型图标之后是进行进一步转换所需的工具。
图1 Doxygen网站上给出的Doxygen信息流图
配置文件
每一个Doxygen工程都有一个后缀为.cfg的配置文件,用来保存所有的设置。配置文件的格式与autoexec.bat、config.sys等文件相似,是由名称/值对组成的ASCII码,会由doxygen命令来解析。为了简化创建和修改配置文件,Doxygen可以在命令行方式下加上参数-g自动创建模板文件。
doxygen -g <config-file>
忽略<config-file>将会生成一个名为Doxyfile的缺省文件,假如<config-file>已经存在,会被Doxygen改名为<config-file>.bak。
赞助商链接