java文档生成器_Java有好用的JavaDoc文档生成工具.pdf

Java有好用的JavaDoc文档生成工具

Java有好用的JavaDoc文档生成工具，那么C++有没有呢？有，这就是大名鼎鼎的

Doxygen，开源，功能强大，支持非常多的编程语言。

1. 安装和配置

首先下载Doxygen1.5.6，然后下载graphviz-2.18，安装。

运行Doxywizard，开始配置。

单击Wizard 按钮，会弹出对话框，输入项目名，这个名字会作为文档的大标题，输

入版本，也会出现在文档中，然后输入源代码的根目录，勾选”Scan recursively”，

输入文档输出路径。如图1所示：

图1

单击Mode标签，不做任何改动，保持默认。

单击 Output 标签，去掉 ” LaTex” ，选择“ prepare for compressed

HTML(.chm)”，因为输出chm 比较方便，只有一个文件就包含所有文档，不向html会

有一堆的文件。如图2所示：

图2

单击Diagrams标签，如果已经安装了GraphViz，则保持默认，如果没安装，则选

择“Use built-in class diagram generator”就足够，如图3所示：

图3

点击OK，返回。

单击Expert按钮，会弹出一个有更多标签页的对话框，在"Project"标签页下，将

OUTPUT_LANGUAGE设置为Chinese，因为我需要生成中文文档，如图4所示：

图4

单击"Input"标签，将 INPUT_ENCODING 保持默认的 utf-8 ，因为我用的是

Visual Studio 源代码文件的编码默认就是utf-8。如图5所示：

图5

如果你有洁癖，你可以耐心的将 FILE_PATTERNS下的后缀一个一个删掉(用记事本

打开配置文件，搜索”FILE_PATTERNS”，一下可以删除一片，免去你点鼠标点到食指抽

筋之苦)，只留下*.h、*.hpp、*.c、和*.cpp等，意思是只扫描C++头文件和源文件，如

图6所示：

图6

下拉滚动条，会有 EXCLUDE和 EXCLUDE_PATTERNS表示不要进行解析的目录和文

件，即工程目录下有的目录不需要进行文档化(比如测试代码)，就用这两个排除掉。

单击“Source Browser”标签，勾选“SOURCE_BROUSER”，这样文档中就会附加一

份源码，方便随时查阅，如图7所示：

图7

单击"HTML"标签，勾选“HTML_DYNAMIC_SECTION”，表示要输出chm文件，同时

在CHM_FILE输入文件名作为要最终生成的chm文件名，旁边的那个"File.."按钮其实

没用。同时点击“HHC_LOCATION”右边的按钮找到chm编译器hhc.exe。如图8所示：

图8

单击OK返回，接下来按“Save...”按钮保存配置文件，文件名随意，如图9所示：

图9

这个配置好的文件以后可以重复利用，每次点” Load…”装载进来，然后点击

”Wizard…”，根据不同的工程，修改工程名字，版本，源代码根目录，文档输出目录就可

以了，不用再重复上述配置。

接下来在输入Working Directory 中一般也输入源代码的根目录，主要是因为配

置的一些选项中有的可以用相对路径，这个就可以作为相对路径的参照点。

最后单击“Start”按钮开始生成文件，到D:/test下查看，发现多了个html文件

夹，进去一看，有很 HTML和一个chm文件，chm文件就是我们所要的文档，不过还不

行，chm的左边导航目录是乱码，还需要一些步骤。

首先用一个文本编辑工具(我用VS2008 打开，可以显示中文，以gb2312 另存的，

可是VS2005 貌似打开是乱码)打开index.hhc文件，因为这个