现已发布! 发布日期:2024 年 12 月 28 日

代码文档。
自动化。

免费、开源、跨平台。

Dark Light

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),允许用户自定义文档生成过程。您可以控制各种设置,例如输出格式、文件包含/排除等等。

赞助链接
(与 doxygen 无关)