Doxygen 的使用方法，本篇以 解析 plog ( .php 檔)為範例做一步一步的解說

 要感謝 Mark 的指導

執行 doxygen

假設你的 plog source 放在 d:\plog

1. Project Name 打上 plog
2. Project Number 打上 0.31
3. 假設你的 document 輸出到 d:\plog\docs
4. create sub_dirs 不要勾，它有一點 bug
   (基本上，勾了，到時輸出會自動幫你分 folder，但最近的版本有) bug
5. output， lang 選 中文 ( Chinese_Traditiona)

切換 tab 到 build

基本上這是要選擇到時要輸出的 document 詳細程度
(我是全選啦！除了幾個 hide 開頭的，所以等一下你會看到很詳細的資料)

切換到 Input

1. 選擇 d:/plog 回我們的 input 目錄
2. 下面的 file pattern，是指定我們只分析 .php 還是 .html 還是 .c
   (基本上我都不選，反正先全部都分析)
3. 再來 recursive 一定要打勾
   (代表下面的每一個子目錄都要分析)

切換到 source browse

之前只是指定要產生 document, 但 doxygen 允許你將 doc & source 放在一起, 比較好看, 我的習慣是將他全部 include, 所以產生的文件比較大, 但好處是不用再去翻 source code.

切換到 index

• 決定要不要索引，你可以打勾
• 另外索引要顯示成幾欄, 基本上 3 欄就很大了, 5 欄會超出螢幕很多.

切換到 HTML

要選擇輸出的文件格式, 基本上只要 HTML , 看一看有什麼要改的, 原則上不動就可以了.

切換到 Latex

把latex 取消

跳到 dot

這個 tab, doxygen 會產生很詳細的 class digram & activity diagram, 但是要有一些 library support, 如果沒裝 library, 他只會產生 class diagram, 所以這一頁看看就好, 也不用去動他.

以上設定完成後, 按一下 save, 把現在的設定存下來.

然後按那個齒輪, 就會幫你產生文件了.

 再次謝謝 Mark 的分享