前言
规范的注释是一个良好的编程习惯。
Doxygen可以直接将注释提取为程序文档,便于开发人员使用
本文主要介绍了Doxygen的使用方法,更多细节请阅读官方文档
一、Doxygen是什么?
doxygen是一个文档生成工具,用于为源码生成文档,我们可以在代码中按照doxygen要求的语法编写代码注释,然后使用doxygen将程序中的注释提取出来生成一个文档
一般都把注释写在代码中,所以使用doxygen生成的文档也可以非常方便地更新。doxygen还会在文档中引用源码文件,故我们也可以在文档中方便地查看源码
二、Doxygen的安装
官网:传送门
1.windows
下载软件.软件安装过程基本无脑下一步
要下载graphviz和Doxygen同时,最好的指定的官方网站上进行下载。
2.安装Graphviz和HTML Help Workshop(可选)
官网: