1. 下載與安裝
1.1 下載
Doxygen官方安裝程序及其手冊下載地址,目前使用版本為1.8.8。
安裝程序:http://www.stack.nl/~dimitri/doxygen/download.html
圖 1-1 Doxygen安裝程序下載界面
在線幫助:http://www.stack.nl/~dimitri/doxygen/manual
圖 1-2 Doxygen幫助文檔下載界面
GraphViz Doxygen官方安裝下載地址及其在線幫助地址,目前使用版本為2.38。
安裝程序:http://www.graphviz.org/pub/graphviz/stable/windows/
圖 1-3 GraphViz安裝程序下載界面
在線幫助:http://www.graphviz.org/Documentation.php
圖 1-4 GraphViz在線幫助界面
1.2 安裝
以上兩個安裝程序可以任意安裝,但是一定要記住Graphviz的安裝路徑,Doxygen的設置中要使用此路徑以生成調用關系圖。
2. Doxygen配置與使用
2.1 基礎配置
Doxygen的配置向導可以完成項目路徑、工作模式、輸出文檔、圖片工具四個方面的簡要配置。
在圖2-1中展示了項目路徑配置的相關內容:其一,可以設置項目的名稱、概述、版本號和項目標志;其二,可以設置源代碼所在路徑,遞歸掃描指是否將子文件夾加入源碼搜索路徑;其三,可以設置代碼文檔的輸出路徑,html、rtf等不同格式的代碼文檔以相應的文件夾存儲在此路徑之下。
圖 2-1 項目配置
在圖2-2所示的工作模式配置中,可以設定代碼文檔中的內容,即包括所有實體還是僅包括標記的實體。除此之外,還要手動選擇Doxygen的運行時優化方案,這里選擇了針對C語言和PHP的優化選項。
圖 2-2 工作模式配置
在圖2-3中,選擇了輸出HTML和RTF格式的代碼文檔,其中還可以設置HTML代碼文檔的輸出內容,包括純HTML文檔、左側帶有導航樹的HTML文檔以及CHM文件支持,還可以更改HTML文檔的配色方案。
圖 2-3 輸出代碼文檔設置
在圖2-4所示的界面中,可以自由設置輸出文檔中是否含有圖片、使用Doxygen內置圖片工具生成圖片、使用GraphViz生成圖片三種方式。
圖 2-4 圖片工具設置
2.2 高級配置
高級配置是對基礎配置的進一步細化,以形成不同風格的注釋文檔。由於涉及參數較多,本文並未給出所有參數的說明,這里僅介紹重要的參數,未盡部分還請讀者自行閱讀窗口左側靠下的參數說明(詳見圖 25左側紅色矩形框所標識的區域)。
圖2-5~圖2-7完成了項目的詳細配置,請注意輸出語言一定要選擇Chinese,一定要勾選圖2-6中的JAVADOC_AUTOBRIEF選項和圖2-7中的MARKDOWN_SUPPORT、AUTOLINK_SUPPORT選項,依次表示支持JavaDoc風格注釋、Markdown標記方法、注釋實體自動鏈接三種功能。
圖 2-5 項目配置一
圖 2-6 項目配置二
圖 2-7 項目配置三
圖2-8中則展示了Doxygen運行時所抽取的內容,一般采用默認設置,也可結合需求根據參數說明自行修改。
圖 2-8 代碼文檔中包含的內容
在圖2-9中,用戶可以自定義Doxygen的運行日志所顯示的內容與方式,可以通過運行日志檢查注釋的正誤。
圖 2-9 Doxygen運行日志的顯示內容和格式
圖2-10和圖2-11依次說明了源碼搜索路徑、示例代碼搜索路徑和外部圖片搜索路徑的設置,這里一定要注意源碼的編碼格式設置為GBK。一旦文件編碼格式有誤,代碼文檔中就會出現亂碼。
圖 2-10 輸入設置一——源碼路徑與編碼格式
圖 2-11 輸入設置二——示例代碼和圖片的搜索設置
可以通過圖2-12實現代碼文檔與源文件之間的交叉引用,方便閱讀,一般使用默認設置。
圖 212 源碼與文檔交叉引用設置
利用圖2-13中索引方法設置,可以實現代碼文檔中的各注釋對象的出現順序,即按照字母順序或者先后順序顯示。
圖 2-13 索引方法設置
圖2-14和圖2-15分別展示了HTML文檔、CHM文檔的設置方法,其中CHM文檔的生成需要HHC編譯器,一般的路徑為C:\Program Files\HTML Help Workshop。
圖 2-14 HTML文檔設置
圖 2-15 CHM文檔設置
代碼的RTF文檔設置如圖圖2-16,如果是小型項目最好勾選COMPACT_RTF選項,據說可以使得文檔更緊湊。如果選中RTF_HYPERLINKS選項,則在RTF文檔中會以鏈接的形式顯示注釋的對象。另外,如果RTF文檔中的頁碼不能正常顯示,請使用WORD中的更新域的命令更新文檔即可。
圖 2-16 RTF文檔設置
通過圖2-17所示的界面,在選擇了GraphViz的路徑之后,可以設置GraphViz生成圖片的種類。
圖 2-17 GraphViz的圖片選項和路徑設置
至此,已經完成Doxygen的所有設置,可以利用【File】和【Settings】菜單保存現有設置、導入已有配置等功能。
2.3 運行Doxygen
Doxygen的運行界面如圖2-18所示,可以在該界面生成代碼文檔、顯示結果和配置文件、保存日志等功能。
圖 2-18 Doxygen的運行界面
請注意,如果Doxygen的運行窗口出現錯誤或者警告,請仔細閱讀並找出問題所在,修改注釋后即可。
另外,再次申明:如果RTF文檔中不能正確顯示頁碼,請對整篇文檔使用"更新域"操作。