jinfeng_wang

G-G-S,D-D-U!

BlogJava 首页 新随笔 联系 聚合 管理
  400 Posts :: 0 Stories :: 296 Comments :: 0 Trackbacks
 

Doxygen的使用体会

 

Doxygen是一款开源软件,可用于从已经存在的VC工程中提炼出软件文档(HTML等格式),包括文件说明、类说明、属性方法说明、类关系等内容。一般常将Doxygen和graphviz两款软件一起安装,后者是一款绘图软件,可在前者生成的软件文档中增加图表。Doxygen的细节可以上网搜索。这里贴一下个人体会,可帮助感兴趣的朋友迅速上手这个软件:

1,安装DOXYGEN和graphviz后,可以在“DOXYGEN安装目录\bin”下用命令行方式运行doxygen.exe -g 生成一个名为Doxyfile的配置文件。

2,将文件Doxyfile复制到想生成文档的VC工程目录下。

修改该文件中的如下选项:

  1. PROJECT_NAME          = 填上项目名称    
  2. OUTPUT_LANGUAGE        = 改为Chinese    
  3. GENERATE_LATEX        = 改为NO    
  4. EXTRACT_ALL            = 改为YES    
  5. HAVE_DOT              = 改为YES    
  6. DOT_IMAGE_FORMAT      = 该为JPG    
  7. DOT_PATH              = 填上"C:/Program Files/ATT/Graphviz/bin/"    
  8. DOTFILE_DIRS          = 填上"c:/Program Files/ATT/Graphviz/bin/"   

 

3,对VC工程进行如下修改

(1)在stdAfx.h中增加预定义,以支持DOT画图。

  1. #ifndef _DIAGRAMS_A_H    
  2. #define _DIAGRAMS_A_H    
  3. #endif   

 

(2)在重要的类、方法、属性前面增加注释,以支持DOXYGEN分析。

  1. ///    @brief 最主要的业务实现类    
  2. ///    
  3. ///            所有的算法内容基本都在这个类中实现。    
  4. ///    
  5. ///    @author lipp   

 

或者放在语句后面

  1. char sFilename[400];            ///< LOG文件名   

 

并在重要文件前增加注释

  1. ///    @file xxx.cpp    
  2. ///    被其他程序调用的,实现了算法的DLL主程序。    
  3. ///    包括各个方法输出接口。   

 

4,运行DOXYGEN.exe。LOAD以上的Doxyfile文件。点击START。这时会生成一个新的HTML目录在VC工程目录中。

5,使用IE打开新生成的HTML目录中的INDEX.htm文件。

 

posted on 2007-06-01 13:06 jinfeng_wang 阅读(1064) 评论(0)  编辑  收藏 所属分类: cppZZ

只有注册用户登录后才能发表评论。


网站导航: