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 閱讀(1160) 評論(0)  編輯  收藏 所屬分類: cppZZ
          主站蜘蛛池模板: 新巴尔虎右旗| 临夏市| 克拉玛依市| 棋牌| 平乐县| 阜平县| 丰台区| 阳泉市| 伊宁市| 宜兰市| 德江县| 龙山县| 济源市| 凤阳县| 乌鲁木齐县| 连南| 新蔡县| 赣州市| 织金县| 南通市| 石泉县| 建宁县| 青神县| 体育| 辽宁省| 绍兴县| 牟定县| 宜兰市| 嵊泗县| 固始县| 阳谷县| 临沭县| 广元市| 达州市| 红原县| 广昌县| 乐清市| 阿拉善右旗| 南部县| 金门县| 定兴县|