Doxygen的使用体会
Doxygen是一款开源软件,可用于从已经存在的VC工程中提炼出软件文档(HTML等格式),包括文件说明、类说明、属性方法说明、类关系等内容。一般常将Doxygen和graphviz两款软件一起安装,后者是一款绘图软件,可在前者生成的软件文档中增加图表。Doxygen的细节可以上网搜索。这里贴一下个人体会,可帮助感兴趣的朋友迅速上手这个软件:
1,安装DOXYGEN和graphviz后,可以在“DOXYGEN安装目录\bin”下用命令行方式运行doxygen.exe -g 生成一个名为Doxyfile的配置文件。
2,将文件Doxyfile复制到想生成文档的VC工程目录下。
修改该文件中的如下选项:
- PROJECT_NAME = 填上项目名称
- 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,对VC工程进行如下修改
(1)在stdAfx.h中增加预定义,以支持DOT画图。
- #ifndef _DIAGRAMS_A_H
- #define _DIAGRAMS_A_H
- #endif
(2)在重要的类、方法、属性前面增加注释,以支持DOXYGEN分析。
或者放在语句后面
并在重要文件前增加注释
4,运行DOXYGEN.exe。LOAD以上的Doxyfile文件。点击START。这时会生成一个新的HTML目录在VC工程目录中。
5,使用IE打开新生成的HTML目录中的INDEX.htm文件。