asoin's blog(beta): [tools]程式註解輸出的好工具─「Doxygen」

程式寫了這麼久，最近才因為修了一門3D遊戲程式才知道這個產生程式文件的好工具，可以方便往後的開發者知道此程式是如何撰寫，各function和parameter是如何定義與操作，不用再去茫茫大海中的source code找註解，而且你只要按照他的格式撰寫註解就可以自動產生一份程式說明文件。以往都是要下指令去執行，不過後來推出Wizard GUI的介面更方便開發者使用，下面是簡單的教學。

開啟主程式 Doxygen Wizard，主要分為四個步驟

1.點選Wizard按鈕先執行各項設定
[Project]
(1).輸入你的Project名稱和版本
(2).設定你產生程式文件的路徑位置

[Mode]
設定你文件產生的模式，這裡我單純只產生資料夾裡的souce code，下方選擇你所撰寫的程式語言

[Output]
產生程式文件的格式，可選擇HTML、LaTeX、XML或RTF格式，這裡我選擇產生一般的HTML格式

[Diagrams]
基本上按照他的預設方式就可以

2.Wizard設定好之後先在step2裡可儲存你的設定值，step3選擇你source code的工作目錄。上述都設定好之後進入step4按下Start產生你的程式註解文件了，下方是產生文件的紀錄檔。

3.下圖是產生文件的結果範例。附帶一提的是程式註解裡不支援中文，包含所有上述所說的Wizard設定路徑目前都只支援英文，如果輸入中文會出現亂碼或路徑找不到的情況發生。