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


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),允許使用者自訂文件產生流程。您可以控制各種設定,例如輸出格式、檔案包含/排除等。