假如您這次還沒來得及使用老式的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.gztar xf doxygen-$VERSION.src.tarsh ./configure，或者configure --platform platform-type（略去直接使用configure需要平臺檢測的過程，平臺類型在PLATFORMS文件中列出），configure --with-doxywizard（GUI前端選項）make，或者make docs（創建HTML格式的手冊），make pdf（創建PDF格式的手冊）      

安裝二進制版本

./configuremake 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。