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

Doxygen支持許多不同的編程語言，其默認值不一定能為C語言提供最佳輸出。當使用Doxygen配置工具Doxywizard時，開發人員應選擇“優化C輸出”選項。選擇按鈕位于模式選項卡下，如圖1所示。如果正在使用C ++，請選擇其中一個選項來優化C ++的輸出。

圖1 - 設置“優化C輸出”選項

提示2 -使用模塊模板一致的文檔

Doxygen掃描代碼庫，尋找以/**開頭的注釋塊，開發人員可以通過在代碼塊中使用Doxygen標記來指定對特定注釋的專門處理。 （標簽很容易被發現，因為它們以@開頭。）例如，@ file標簽將通知Doxygen，后面的注釋提供了模塊的文件名。圖2顯示了帶有Doxygen標記的注釋塊的示例。

圖2 - Doxygen注釋塊

但Doxygen支持100多個不同的標簽，這意味著使用Doxygen記錄軟件具有潛力很快就搞砸了。將Doxygen與嵌入式軟件一起使用的最佳建議之一是為頭文件和源文件創建模板。模板文件應包含示例代碼塊和標頭，然后可以在實現階段使用它們。可以在此處找到模板外觀的示例。

提示3 -創建主頁

Doxygen將掃描開發人員在配置文件中發出的任何文件類型，并具有能夠解析稱為主頁的特殊類型的文件。主頁面是一個用戶可配置的頁面，默認情況下在加載HTML文檔時顯示，或者出現在生成的RTF文件的開頭。主頁面是開發人員描述項目，背景和任何可能對手冊讀者有用的編碼約定的理想場所。

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

項目是什么以及它的目的是什么

編碼標準的鏈接

指向項目的C樣式指南的鏈接

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

版本日志

使用的常規Doxygen約定

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

有用的工具以及它們在項目中的使用方式

提示4 -使用GraphViz中的點工具

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

類圖

依賴關系圖表

調用圖表

調用圖表

點生成的圖表可以使用圖形表示為開發人員提供對軟件的深入了解，允許快速瀏覽漂亮的圖片以提供深刻見解。

提示5 -對于HTML，生成樹視圖

默認情況下，Doxygen會生成一個HTML輸出中的頂級菜單，開發人員可以從中導航代碼庫。頂部菜單很有用，但生成樹視圖是一種更有效的導航方法。可以通過專家HTML選項卡啟用選項GENERATE_TREEVIEW來創建樹視圖。

提示6 -不要將Doxygen添加到編譯器命令行

一旦開發人員開始使用Doxygen它就可以了每次編譯代碼庫時，都很想通過編譯器命令行調用Doxygen。但是，在每個編譯時解析文檔的代碼庫是一個很大的錯誤，因為Doxygen可能需要“很長”的時間來解析文件并生成文檔。時間的流逝可能會大大減緩開發速度。相反，開發人員應該在將任何新開發的軟件添加到版本控制系統之前創建文檔。

提示7 -做將Doxygen評論添加到C風格指南中

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