文档生成工具doxygen+图像生成工具GraphViz

Posted 2020-07-22

文档生成工具doxygen+图像生成工具GraphViz

虽然jdk自带的javadoc也很好用，不过使用doxygen+GraphViz 的组合可以生成许多强大的图（类图、协作图、文件包含/被包含图、函数调用/被调用图、类继承体系图等），另外，doxygen支持直接生成chm文档，支持LaTeX公式，如果你有一个支持php的服务器，生成的html还可以加入一个搜索框。

doxygen是开源的C语言软体，可以在它的官方网站上下载到软体和源码：
http://www.stack.nl/~dimitri/doxygen

使用它的doxyWizard很是方便^^ 具体用法我写在了附件的文档中（不过注释是C++版，doxygen是可以使用默认的javadoc注释的，你只需要将设定改成output for Java）。
它还可以自定义css/head/foot，由于用于内部交流于是就没有设定，可以在Export的HTML选项卡中修改，传说中MySQL的文档就是doxygen生成的。。。

doxygen内置了生成类图的功能，只需要设定Diagram的项。
要生成更多图的请下载GraphViz。
它是一款强大的可以生成很多种图像的软件，同样也是开源的：http://www.graphviz.org/。
它还提供了Java支持，有一个纯java编写的子项目Grappa。按照上面的说明，似乎java程序可以通过Grappa库来实现GraphViz的功能（Grappa调用GraphViz的接口）。

大家有兴趣可以尝试一下 挺好玩的说^^
附件是一个Doxygen使用简介.docx，里面包含了我这几天玩得doxyWizard的简单使用说明。
以及 一个使用doxyWizard生成的chm文件，只用了类图、文件包含图和类继承体系图。

【Doxygen使用简介.docx】 【DBOp.chm】

生成图演示：

• 类图
  
• 协作图
  
• 文件包含图
  
• 函数调用图
  
• 类继承体系图
  
• http://www.cppblog.com/prayer/archive/2009/12/24/103989.html