此前寫過一篇編寫Doxygen格式的注釋以用于生成文檔,點擊以查閱, Doxygen常用語法與字段記錄,但是當時用的windows桌面版的doxygen,最近使用ubuntu編寫代碼想直接使用doxygen生成,故寫下此博客

Doxygen

Doxygen是一個用于生成軟件文檔的工具，它可以從代碼中提取注釋并根據這些注釋自動生成文檔。這些注釋可以是特殊格式的注釋，比如C、C++、Java等語言中的特定格式，也可以是Markdown格式的注釋。
以下是一些Doxygen的主要特點和用途：

1. 自動生成文檔：Doxygen可以從源代碼中提取注釋，并生成各種格式的文檔，包括HTML、PDF、LaTeX等。這樣可以輕松地為你的項目生成專業的文檔。
2. 支持多種編程語言：Doxygen支持多種編程語言，包括C、C++、Java、Python等主流編程語言。你可以在不同的項目中使用Doxygen來生成文檔。
3. 豐富的文檔格式：Doxygen支持多種文檔格式，包括類圖、調用圖、文件列表等。它還支持跳轉到定義、引用和繼承等功能，使生成的文檔更加詳細和易于導航。
4. 可定制性強：Doxygen提供了豐富的配置選項，可以根據你的需求定制文檔的樣式和內容。你可以通過配置文件或命令行選項來控制生成的文檔。
5. 支持多種輸出格式：Doxygen可以生成多種格式的輸出文檔，包括HTML、PDF、LaTeX等。這使得你可以選擇最適合你項目的文檔格式。我們在接下來的課程當中，主要使用它來了解第三方庫的使用。

Doxygen安裝

在 Ubuntu 系統中，執行下面命令安裝 doxygen 和 graphviz 軟件包。

sudo apt install graphviz    # 用于生成代碼關系圖
sudo apt install doxygen

使用示例

進入工程目錄，執行下面命令生成配置文件

doxygen -g Doxygen.config

修改配置文件vim Doxygen.config,找到如下字段修改為YES

對于美觀有要求可以自行查閱相關資料,修改一些字段

EXTRACT_ALL            = YES
HAVE_DOT               = YES
UML_LOOK               = YES
RECURSIVE              = YES

根據代碼生成文檔

doxygen Doxygen.config

生成效果展示