Doxygen是一个从程序源码生成文档的工具,主要用于C/C++源码,也支持其他如PHP, Java, Python等代码。具体来说,Doxygen服务于以下两个目的:

  1. 从带注释标记的源码中生成文档,一般是HTML格式,当然也支持其他可离线查看的格式。生成的文档是直接从源码的注释中提取的,这样程序员就可以边写代码边写注释,同时完成编码和文档工作。
  2. 从源码中提取代码结构,生成整个工程的框架文档,并且提供可视化的展示,比如UML类图,继承图,头文件包含等。

除了从源码中生成文档外,Doxygen也支持直接创建正常的文档,这点Doxygen和Gitbook类似,Doxygen的在线文档就是用Doxygen编写的。


参考链接:

https://www.doxygen.nl/index.html

https://www.cnblogs.com/silencehuan/p/11169084.html

  • 无标签