Doxygen的使用體會(huì)
Doxygen是一款開(kāi)源軟件，可用于從已經(jīng)存在的VC工程中提煉出軟件文檔（HTML等格式），包括文件說(shuō)明、類(lèi)說(shuō)明、屬性方法說(shuō)明、類(lèi)關(guān)系等內(nèi)容。一般常將Doxygen和graphviz兩款軟件一起安裝，后者是一款繪圖軟件，可在前者生成的軟件文檔中增加圖表。Doxygen的細(xì)節(jié)可以上網(wǎng)搜索。這里貼一下個(gè)人體會(huì)，可幫助感興趣的朋友迅速上手這個(gè)軟件：
1，安裝DOXYGEN和graphviz后，可以在“DOXYGEN安裝目錄\bin”下用命令行方式運(yùn)行doxygen.exe -g 生成一個(gè)名為Doxyfile的配置文件。
2，將文件Doxyfile復(fù)制到想生成文檔的VC工程目錄下。
修改該文件中的如下選項(xiàng)：
- PROJECT_NAME = 填上項(xiàng)目名稱
- OUTPUT_LANGUAGE = 改為Chinese
- GENERATE_LATEX = 改為NO
- EXTRACT_ALL = 改為YES
- HAVE_DOT = 改為YES
- DOT_IMAGE_FORMAT = 該為JPG
- DOT_PATH = 填上"C:/Program Files/ATT/Graphviz/bin/"
- DOTFILE_DIRS = 填上"c:/Program Files/ATT/Graphviz/bin/"
3，對(duì)VC工程進(jìn)行如下修改
（1）在stdAfx.h中增加預(yù)定義，以支持DOT畫(huà)圖。
- #ifndef _DIAGRAMS_A_H
- #define _DIAGRAMS_A_H
- #endif
（2）在重要的類(lèi)、方法、屬性前面增加注釋，以支持DOXYGEN分析。
或者放在語(yǔ)句后面
并在重要文件前增加注釋
4，運(yùn)行DOXYGEN.exe。LOAD以上的Doxyfile文件。點(diǎn)擊START。這時(shí)會(huì)生成一個(gè)新的HTML目錄在VC工程目錄中。
5，使用IE打開(kāi)新生成的HTML目錄中的INDEX.htm文件。