使用Doxygen构建文档系统Unix系统 电脑资料

使用Doxygen构建文档系统Unix系统 电脑资料 作者：车皓阳 作者简介 车皓阳，您可以通过grandiose11msn.和作者取得联系， 作者：车皓阳 车皓阳，您可以通过grandiose11msn.和作者取得联系。 如果您这次还没来得及使用老式的Help Workshop为您的Web应用构建文档系统的话，那么，何不尝试一下Doxygen，需知The proof of the pudding lies in the eating。 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和Unixman page等。 Doxygen在Linux上开发，但也可以在其它的Unix平台下运行。而且，Windows9x/NT平台下也有对应的可执行版本。 首先，去Doxygen网站上找到最新版本的Doxygen。有二进制或源码两种版本，如果不想重头编译，下载二进制版本安装即可。在Linux下，源码编译需要perl和Gnu工具flex、bison、make的支持。在Windows下，二进制版本勿需安装，而源码编译所需支持工具较多。我们仅讲述Linux下的Doxygen的源码编译以及二进制版本安装过程。 编译源码 安装二进制版本 二进制文件安装目录是 /bin，其中 电脑资料 使用doxygen构建文档系统unix系统( s:/)。对于详细描述来说，有下面几种表示方式。 Doxygen支持的指令非常多，主要作用是控制输出文档的排版格式。命令以或号开始。 一些命令可以有多个参数，一些命令只有一个参数。参数周围的括号使用是有含义的： 号表示参数是单个词。 ()号表示参数一直会到行尾。 号表示参数会扩展到下一段落。 号表示参数是可选的。 下面章节中也涉及到一些命令的使用，其它的命令可以查阅Doxygen用户手册。 Doxygen有许多方法可以创建项目列表。 Doxygen有两种分组机制。第一种是全局地为每一个组创建一个网页，此时分组被称为module；第二种是用于复合实体中的成员列表，此时分组被称为member group。Module是一种把内容在单个网页上分组的方法。分组可以包括files，namespace，classes，functions，variables，enums，typedefs和defines，也可以包含其它分组。复合实体（pound entities）如类、文件、命名空间等可以分布在多个分组中，而成员实体（member）如变量、函数、typedef等只能归属于一个分组。 定义分组的方法是在特殊注释块中使用命令defgroup和addtogroup。 defgroup的格式如下： defgroup （中间可以有空格的标题） 两次使用同一标识名，在doxygen解析的时候会出现错误。命令addtogroup与defgroup不同的地方在于，如果使用了同一标识，则会在改组中加入新的项，如果标识不重复，则会创建分组。addtogroup中的标题是可选的。 声明分组之后，如果要使某个实体归属某一分组，需要使用ingroup命令。避免在每个成员之前都使用ingroup命令，可以将member用封装起来。 上面这些命令都是有优先级的，doxygen会根据优先级将实体放入具有最高优先级的分组之中。它们的优先级顺序是：ingroup，defgroup，addtogroup，weakgroup。weakgroup类似一个低优先级的addtogroup。在.h文件中可以使用高优先级的命令定义层次结构，在.c文件中weakgroup就不需要准确遵循.h文件中定义的层次结构。 如果要把不同的类型归入同一分组内，就要使用Member group，它的定义方法如下： Member group不可以嵌套。 Doxygen里有内置生成C+类层次图的功能。它使用贝尔实验室开发的graphviz 1.5中的工具dot来生成更高级的图表。使用这个工具时，要将配置选项HAVE_DOT设为YES。 当GRAPHICAL_HIERARCHY设置为YES时，将会绘制一个图形表示的类图结构。 当CLASS_GRAPH设置为YES时，会为每个归档的类创建一张图表示其直接或间接的继承关系。 当INCLUDE_GRAPH设置为YES时，会为每个归档文件创建一幅包含依赖图，此功能目前仅有HTML和RTF格式支持。 当COLLABORATION_GRAPH设置为YES时，会为每个归档类或结构绘制基类继承关系图和使用关系图。 当CALL_GRAPH设置为YES时，会为每个函数显示一幅直接或间接调用关系图。 更具体的信息可以参考Doxygen的手册。 Doxygen可以把LaTeX格式的公式输出出来。要在HTML文档里包含公式，需要安装下面的工具：latex（LaTeX编译器）、dvips（将DVI文件转换为PS文件）、gs（将PS文件转换为位图）。 包含公式的方法有两种： Doxygen支持多种语言，输出中文文档的时候，只需要将配置文件中的OUTPUT_LANGUAGE标签设置为Chinese即可（用Doxywizard修改更方便）。 有一个需要注意的问题是，在Windows下的浏览器浏览中文HTML文档时，英文字母会变得很难看，解决的办法是将doxygen_.css下载到本地硬盘，并将配置文件中的HTML_STYLESHEET修改为这个文件的位置。 HTML_STYLESHEET=c:doxygendox