Doxygen 使用方法
1、第一次使用需要安装doxygen的程序2、生成doxygen配置文件
3、编码时,按照某种格式编写注释
4、生成对应文档
Doxygen 特别说明
1.doxygen的安装非常简单。在linux下,您可以直接下载安装包并运行它。下载源代码、编译和安装也是编译和安装的常用命令。2.生成文档时,可以在文档生成过程中定义项目属性和许多选项。您可以使用以下命令生成默认配置文件:doxygen-g[配置文件名]
3.配置文件中对应的项目可以根据项目的具体要求进行修改,修改后的配置文件可以作为以后项目的模板。
4.让软件自动生成文档,但是平时的标注风格不行,需要按照自己的格式。
5.好了,代码写完了,评论按照格式写。最后的文件是什么?很简单,运行下面的命令,就会在指定的目录下生成相应的文档:doxygen[配置文件名]
6.需要注意的是,doxygen并不处理所有的注释,而是侧重于与程序结构相关的注释,比如文件、类、结构、函数、变量和宏的注释,而忽略了函数内变量和代码的注释。