歡迎您光臨本站 註冊首頁

Doxygen使用

←手機掃碼閱讀     火星人 @ 2014-03-29 , reply:0

doxygen 是一個代碼文檔生成器,不過功能上還算不錯,目前對中文支持也是很好。

1. 首先從http://www.stack.nl/~dimitri/doxygen/ 下載一份最新的源程序,如果是源碼包,那麼用tar 打開./configure->make ->make install,那麼就安裝好了,如果是debian用戶,現在源裡面已經有,可以直接apt安裝

2. 安裝好后可以先看看他的文檔,有比較詳細的說明,一般linux用戶在/usr/share/doc/doxygen 下面,裡面還有一個example,這個比較不多,可以看多很的例子。

3. doxygen 使用也是非常的簡單,首先 doxygen -g file(file 為配置文件,如果沒有指定 那麼它會自動給你生成一個 Doxyfile) .

4. 之後就是對配置文件的修改了,具體的修改可以看它的Doc,這裡說幾個比較重要的

PROJECT_NAME 項目名稱 RECURSIVE =YES 設置是否遞歸
PROJECT_NUMBER 項目版本 EXCLUDE =dir pattern 排除的目錄
OUTPUT_DIRECTORY =dir 輸出的目錄 INLINE_SOURCES =yes 會顯示源碼
OUTPUT_LANGUAGE= 輸出的語言 目前支持很多 中文也支持
EXTRACT_ALL = YES 的話將包括的文件都分析
INPUT =dir 出入的目錄
FILE_PATTERNS =*.c *.h *.cpp .... 分析的文件後綴

還有其他一些,可以看文檔

5. 代碼的註釋,以及一些命令,一般和javadoc 相似,

@author @param @date @file @sa 等等

6. 寫好后運行 doxygen -s file 就可以了

7. doxygen可以生成各種格式的文檔 除了 html 還有 man latex rtf , 而且也支持數學公式的生成,以及圖片的生成 如類關係圖

8. 總之doxygen一個不錯的開源doc生成器,今後我將陸續寫些使用tip

[火星人 ] Doxygen使用已經有302次圍觀

http://coctec.com/docs/linux/show-post-200803.html