對于有紀律的嵌入式開發人員來說，Doxygen 是一個了不起的工具，他們希望快速生成與他們的代碼保持同步的軟件手冊。它掃描您的代碼，解析出開發人員的注釋，并將注釋與軟件對象和功能相關聯。結果輸出可以是鏈接的HTML、rtf或LaTex文件，然后作為應用程序的知識主體。然而，為了充分利用Doxygen，開發人員在使用該工具時應該記住這七個關鍵技巧。

　　技巧1——優化C語言的輸出

　　Doxygen支持許多不同的編程語言，它的默認值不一定能為C語言提供最好的輸出。當使用Doxygen配置工具Doxywizard時，開發人員應該選擇“為C優化輸出”選項。選擇按鈕位于mode選項卡下。

　　技巧2——使用模塊模板以獲得一致的文檔

　　Doxygen掃描代碼庫，尋找以/**開頭的注釋塊，嵌入式開發人員可以通過在代碼塊中使用Doxygen標記來指定特定注釋的特殊處理。(標簽很容易被發現，因為它們以@開頭。)例如,@file標簽將通知Doxygen后面的注釋提供了模塊的文件名。圖2展示了一個帶有Doxygen標簽的注釋塊的例子。

　　但是Doxygen支持100多種不同的標簽，這意味著使用Doxygen編寫軟件文檔可能會很快變得混亂。在嵌入式軟件中使用Doxygen的最佳建議之一是為頭文件和源文件創建一個模板。模板文件應該包含示例代碼塊和頭文件，以便在實現階段使用。

　　技巧3——創建主頁

　　Doxygen將從配置文件中掃描嵌入式開發人員告訴它的任何文件類型，并能夠解析一種稱為主頁的特殊類型的文件。主頁是一個用戶可配置的頁面，默認情況下在加載HTML文檔時顯示，或者出現在生成的RTF文件的開頭。對于開發人員來說，主頁是描述項目、背景和任何可能對手冊讀者有用的編碼約定的最佳地方。

　　主頁通常會描述以下內容：

　　項目是什么，目的是什么

　　鏈接到編碼標準

　　鏈接到項目的C風格指南

　　代碼庫中使用的任何縮寫的概述

　　版本日志

　　使用的一般Doxygen慣例

　　可能有用的項目文檔的鏈接

　　有用的工具以及它們如何在項目中使用

　　技巧4——使用GraphViz的點工具

　　從GraphViz包中啟用點工具為Doxygen提供了一個非常強大的圖形選項，允許嵌入式開發人員生成如下圖形：

　　類圖

　　依賴圖

　　調用圖

　　被調用圖

　　點生成的圖形可以使用圖形表示向開發人員提供對軟件的洞察力，允許快速瀏覽漂亮的圖片以提供很好的洞察力。

　　技巧5——對于HTML，生成樹形視圖

　　默認情況下，Doxygen將在其HTML輸出中生成一個頂部菜單，開發人員可以通過該菜單瀏覽代碼庫。頂部菜單很有幫助，但是生成樹形視圖是一種更有效的導航方法。可以通過expert HTML選項卡啟用GENERATE_TREEVIEW選項來創建樹視圖。

　　技巧6——不將Doxygen添加到編譯器命令行

　　一旦嵌入式開發人員開始使用Doxygen，每次編譯代碼庫時，通過編譯器命令行調用Doxygen會很有誘惑力。但是，每次編譯時都解析文檔的代碼庫是一個很大的錯誤，因為Doxygen可能需要“很長”時間來解析文件和生成文檔。時間的沖擊會大大降低開發速度。相反，開發人員應該在將任何新開發的軟件添加到版本控制系統之前創建文檔。

　　技巧7——做將Doxygen注釋添加到C風格指南中

　　開發團隊應該使用C風格指南，告訴工程師在開發過程中要使用的風格慣例。風格指南應該反映Doxygen模板和約定，以便為嵌入式開發人員提供如何在整個代碼庫中一致地編寫注釋的指導。采用Doxygen也應該導致對這個重要的開發團隊文檔的更新。