Doxygen 筆記

下載點

先安裝 Doxygen 再安裝 Graphviz

1.Doxygen
Link

2.Graphviz
Link

Windows 下使用 doxygen 閱讀和分析 C/C++代碼

雖然使用各種 IDE 或者 Source Insight 可以方便地在 windows 下閱讀和分析 C/C++代碼,但是一步步 Go to Definetion 實在令人痛苦。Doxygen 能夠生成函數調用關係圖,所有的函數調用關係可以一目了然,另外他還能統計文檔中所有的類,成員變數,成員函數等。總的來說,Doxygen 不但能從局部把握代碼,還能從全局審視代碼,後者是一般 IDE 和 Source Insight 不能做到的。所以,使用 doxygen 閱讀分析代碼可以達到事半功倍的效果。

doxygen 的安裝很簡單,到官方網站下載 doxygen 的 windows 安裝程式即可。除了安裝 doxygen 外,還需要安裝 graphviz,因為 doxygen 需要使用 graphviz 的 dot.exe 生成調用圖。graphviz 在它的官方網站上也可以下載到安裝程式。不過我下載的安裝程式在安裝時老是報 cab 檔錯誤。最後我下載了 graphviz 的 release 檔,即安裝程式下面的 zip 壓縮檔,下載完成後解壓縮即可。

安裝完 doxygen 後即可進行適當的配置,然後運行 doxyfile 生成文檔。基本的配置前人早有說明,不再贅述。需要注意的是:

  1. 要勾選 Expert->Dot 選項卡下面的 HAVEDOT、CALL_GRAPH 、CALLER_GRAPH 選項。並在 DOT_PATH 下面填入 dot.exe 的路徑,也就是 graphviz 安裝目錄下的 bin 檔夾。
    **(default: C:\Program Files (x86)\Graphviz2.38\bin)_\\
  2. 勾選 Wizard->Project 選項卡下面的 Scan recursively!
  3. 勾選 Expert ->Build 選項卡下面的 EXTRACT_ALL、EXTRACT_PRIVATE、EXTRACT_STATIC、EXTRACT_LOCAL_CLASSES、EXTRACT_LOCAL_METHODS 選項
  4. 如果程式裏面有中文,Exoert -> project -> DOXYFILE_ENCODING INPUT_ENCODING 改為 BIG5
  5. 可以勾掉 LATEX 輸出,這樣節省編譯時間
  6. Doxygen 效果請參考附件圖片
  7. Expert -> Source Browser 可以勾選 SOURCE_BROWSER 可以在網站上看到 source code

Vs code 自動生成 Doxygen 格式註釋(有用 Vs code 仁兄可參考)
Link


  轉載請註明: YuYan's blog Doxygen 筆記

  目錄