Doxygen —— 快来为你的代码自动生成一份专属说明文档

简介

Doxygen是一个能从带注释的源码中自动生成说明文档的标准工具，它支持众多流行的编程语言，包括C/C++、C#, PHP, Java, Python, IDL 等

Doxygen能够从以下三个方面进行工作：

• 从一组源文件中生成HTML格式的在线文档和LETEX格式的离线文档，此外还提供了RTF（MS-Word）、PostScript、超链接 PDF、压缩 HTML 和 Unix等格式输出。

• 从源码中提取代码结构，通过依赖关系图、继承图和协作图自动生成各种元素之间的关系图。

• 为用户制作用户手册和网站

  Doxygen可以在Mac OS、Linux和Windows下工作，还可以在大多数其他Unix上运行。

安装

Ubuntu下可以直接从apt源进行安装

sudo apt-get install graphviz
sudo apt-get install doxygen
# 带gui的doxygen
sudo apt-get install doxygen-gui