doxygen 辅助阅读代码的神器

简介

Doxygen是一个文档生成工具，主要用于编写编程语言的软件文档。它最初是为C++设计的，但后来增加了对C、C#、Java、Objective-C、Python、IDL（在某些情况下还有PHP、C#和D）的支持。Doxygen可以从一组带有文档注释的源代码文件中提取文档，并生成多种格式的可视化文档。

这些注释通常遵循特定的格式，以便Doxygen能够解析它们并组织相关的文档信息。Doxygen可以生成HTML、LaTeX、RTF、PostScript、PDF和纯文本等格式的文档，也支持生成在线或离线的HTML文档，并可以自动创建超链接、代码结构图和依赖关系图。

除了代码注释，Doxygen也支持markdown语法，使得编写额外的文档成为可能。

Doxygen的主要特点和优势包括：

• 自动生成API文档：从标记的代码注释中提取信息。
• 支持多种格式的输出：包括HTML、LaTeX等。
• 支持多种编程语言：C++、C、Java等。
• 创建图表：与Graphviz等工具集成，生成类继承图和合作图。
• 跨平台：在Windows、Mac OS X和Linux等多种操作系统上可用。
• 可定制性强：通过Doxyfile配置文件提供大量可定制选项。

Doxygen是开源软件，可以免费使用，非常适合开发人员为他们的代码库创建详细和结构化的文档。

使用方法

1. 安装Doxygen：

   • 访问Doxygen的官网（http://www.doxygen.nl/）并下载适用于你操作系统的Doxygen安装包。
   • 遵循安装指南完成Doxygen的安装。

2. 安装VSCode插件：

   • 按照上面的步骤在VSCode中安装Doxygen插件。
     

3. 配置Doxygen：

   • 在你的项目根目录下创建一个Doxygen配置文件，通常这个文件被命名为Doxyfile。
   • 你可以在命令行中运行doxygen -g来生成一个默认的Doxyfile。
   • 编辑Doxyfile以满足你的需求，例如设置项目名称、版本号、源代码目录、生成的文档目录等。
   • 配置Doxygen：
     使用文本编辑器打开 Doxyfile。
     修改相关配置以适应你的项目，诸如 PROJECT_NAME、INPUT (源代码目录)、OUTPUT_DIRECTORY (文档输出目录) 等。
     可以设置 RECURSIVE 为 YES 来告诉Doxygen递归地搜索所有子目录。
     保存并关闭配置文件。

4. 使用Doxygen注释代码：

   • 在你的源代码中使用Doxygen注释标记（如/** ... */ 或 /*! ... */）来文档化你的类、函数、变量等。
   • 确保遵循Doxygen的注释格式，以便能正确生成文档。

5. 生成文档：

   • 一旦你的代码已经使用Doxygen注释完毕，并且Doxyfile配置好了，你可以在命令行中运行doxygen Doxyfile来生成文档。
   • 根据你的Doxyfile配置，文档可以是HTML、LaTeX、RTF等格式。

6. 阅读
   生成的文档，可以放到web服务器目录下，打开链接即可阅读。

参考
https://www.doxygen.nl/#cplusplus