doxygen 的安裝、配置、編譯及使用(從源代碼到文檔)

1. 什么是 doxygen

下面是 doxygen 主頁(yè)上的一段說(shuō)明文字

Source code documentation generator tool

Doxygen is a documentation system for C++,

C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors),

Fortran, VHDL, PHP, C#, and to some extent D.

簡(jiǎn)單地說(shuō)，doxygen 能夠自動(dòng)分析源代碼并從源代碼中抽取相應(yīng)的注釋，整理成文檔。

它的好處是源代碼與文檔同步，易于維護(hù)

下面以Fedora 10 和 doxygen 1.5.8 為例來(lái)說(shuō)明其安裝和使用

2. 安裝

a. 下載源代碼

b. 下載用戶(hù)手冊(cè)

這里面的內(nèi)容很詳細(xì)，從下載、編譯、安裝、使用都寫(xiě)得很清楚

c. 編譯

這是linux下標(biāo)準(zhǔn)的安裝方式

首先用tar命令 解壓源代碼，然而用cd命令進(jìn)入解壓后的文件夾，

運(yùn)行./configure --help 查看配置

運(yùn)行 ./configure --enable-langs --with-doxywizard --with-doxyapp進(jìn)行配置

編譯 make

安裝 make install

3. 使用

doxygen

生成文檔的基本方式是先生成一個(gè)配置文件，告訴doxygen如何去生成文檔，然后讓doxygen生成文檔。由于doxygen的配置文件選項(xiàng)有很多，

因此我們通常是讓doxygen先生成一個(gè)默認(rèn)的配置文件，再修改其中的一些選項(xiàng)，生成自己的配置文件。

a. 生成默認(rèn)配置文件

首先用 cd命令，進(jìn)入 源代碼所在的文件夾

然后運(yùn)行 doxygen -g命令，生成 默認(rèn)的配置文件

因?yàn)闆](méi)有指定配置文件的文件名，因此生成的默認(rèn)配置文件 自動(dòng)命名為 Doxyfile

b. 修改配置選項(xiàng)

用任何一種文本編輯器，打開(kāi) Doxyfile 文件

下面是一些配置選項(xiàng)及說(shuō)明

RECURSIVE = YES?? 這可以讓doxygen從配置文件所在的文件夾開(kāi)始，遞歸地搜索所有的子目錄及源文件

SOURCE BROWSER = YES 這會(huì)在最后生成的文檔中，把所有的源代碼包含在其中

INLINE SOURCES ＝ YES 這會(huì)把函數(shù)的實(shí)現(xiàn)部分的代碼包含在每個(gè)函數(shù)的說(shuō)明部分，可以方便地查看函數(shù)的實(shí)現(xiàn)方式，但會(huì)讓整個(gè)文檔顯得有些凌亂，故不推薦使用

GENERATE TREEVIEW ＝ ALL 這會(huì)在HTML文檔中，添加一個(gè)側(cè)邊欄，并以樹(shù)狀結(jié)構(gòu)顯示包、類(lèi)、接口等的關(guān)系

GENERATE_LATEX = NO 這個(gè)設(shè)置將導(dǎo)致doxygen不生成pdf文檔，不太喜歡pdf文檔，把它關(guān)了吧

c. 生成文檔

運(yùn)行 doxygen Doxyfile 命令，生成文檔

d. 查看文檔

在 html 文件夾下，找到index.html文件，用瀏覽器，打開(kāi)它，就可以查看生成的文檔了 ^_)^

總結(jié)

以上是生活随笔為你收集整理的doxygen生成html文件,doxygen 的安装、配置、编译及使用(从源代码到文档)的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。