程式碼文件。
自動化。
免費、開源、跨平台。


Doxygen 是一個在軟體開發中廣泛使用的文件產生工具。它可以自動從原始碼註解中產生文件,解析關於類別、函式和變數的資訊,並以 HTML 和 PDF 等格式輸出。透過簡化和標準化文件編寫流程,Doxygen 可以增強跨多種程式語言和專案規模的協作和維護。
多種輸出格式
Doxygen 可以產生多種輸出格式的文件,例如 HTML、PDF(透過 LaTeX)、Word(透過 RTF)和 XML。
這種彈性允許開發人員選擇最適合他們需求的格式,或將文件整合到不同的系統中。

Markdown
Doxygen 中的 Markdown 支援讓您可以結合 Markdown 的簡潔性和 Doxygen 的強大功能來編寫程式碼文件。
除了 Markdown 之外,Doxygen 還支援許多命令,例如 \param
、\return
、\brief
等,以提供有關函式、參數和回傳值的額外資訊。

C++
Doxygen 為 C++ 程式碼文件提供強大的支援,它可以識別該語言的複雜性並產生全面的文件。
除了 C++ 之外,Doxygen 還支援 C、Python、PHP、Java、C#、Objective-C、Fortran、VHDL、Splice、IDL 和 Lex。

交叉參照
Doxygen 提供交叉參照功能,允許使用者在文件的不同部分之間導覽。
Doxygen 會產生指向相關元素的超連結,讓您輕鬆瀏覽程式碼庫並了解不同組件之間的關係。
圖表
Doxygen 可以產生類別階層和協作圖的圖形表示,提供類別和函式之間關係的視覺概觀。

組態
Doxygen 提供一個組態檔案 (Doxyfile),允許使用者自訂文件產生過程。您可以控制各種設定,例如輸出格式、檔案包含/排除等等。