doxygen

Doxygen是一款知名的开源帮助文档生成器，主要面向C、C++、Java等编程语言。开发者通过在源代码中添加特定格式注释，工具能够自动扫描代码，提取类、函数、变量说明、参数与返回值信息，批量生成结构化文档。Doxygen支持输出HTML、PDF、CHM、LaTeX等多种格式，可生成类继承图、调用关系图，方便团队查阅项目接口。

功能特色

【多输出格式】

Doxygen 能够生成多种格式文档，包括 HTML、PDF（借助 LaTeX）、Word（借助 RTF）以及 XML。

凭借这项灵活特性，开发者可以按需选择合适格式，或是将文档集成至各类系统。

【Markdown 支持】

Doxygen 内置 Markdown 支持，你可以兼顾 Markdown 的简洁语法与 Doxygen 强大的代码注释能力。

除 Markdown 外，Doxygen 支持 `\param`、`\return`、`\brief` 等指令，用于补充函数、参数、返回值相关说明。

【C++ 语言支持】

Doxygen 对 C++ 代码注释拥有完善支持，能够识别该语言复杂语法结构并生成完整文档。

除 C++ 以外，同时支持 C、Python、PHP、Java、C#、Objective-C、Fortran、VHDL、Splice、IDL、Lex。

【交叉引用】

Doxygen 具备交叉引用功能，支持在文档各个模块之间跳转浏览。

工具会为相关代码元素自动生成超链接，方便研读代码库，理清各个组件之间的关联。

【图表生成】

Doxygen 可自动生成类继承关系图、协作图，以可视化形式直观展示类与函数之间的依赖关系。

【配置功能】

Doxygen 提供配置文件（Doxyfile），使用者可自定义文档生成流程。能够自由配置输出格式、文件包含/排除规则等大量参数。

软件亮点

1、代码文档自动生成

主流开源注释文档工具，读取源码内规范注释，自动生成项目开发文档，适配C/C++、Java、PHP等多种编程语言。

2、丰富输出格式

支持导出HTML、PDF、CHM、LaTeX、RTF、Markdown等格式，网页文档自带索引、搜索功能，便于查阅。

3、注释语法灵活

支持单行、多行专用注释标签，可标注函数参数、返回值、注意事项、示例代码、版本信息。

4、类与关系可视化

搭配Graphviz可自动生成类图、调用关系图、继承结构图，直观展示代码架构依赖。

5、高度自定义配置

通过配置文件调整文档主题、目录结构、文件过滤、命名规则，按需开启或者关闭各类模块信息。

6、工程集成友好

可嵌入CMake、Makefile、CI流水线，构建项目时自动同步更新文档，维持代码与说明同步。