[②Doxygen]: 说明书生成

前言

博主在上篇博客[①Doxygen] : 入门，注释语法简介中已经介绍了Doxygen的安装方法以及基本的注释语法，现在就介绍下Doxygen在Ubuntu 18.04 系统中说明书的生成方法。

Step1：创建Doxyfile文件

在系统中安装完Doxygen后，可以用以下命令生成一个名为Doxyfile的配置文件：

doxygen -g

然后我们就可以看到跟下面类似的Doxyfile文件，文件里里面包含了大量的注释说明，其中黑色的标签部分（tag）可以用户自定义修改，修改项非常多，合理的修改可以让生成的说明书变得十分精美。

Step2：修改Doxyfile文件

由于可以修改的tag非常多，这里博主举出关键的几个：

1. PROJECT_NAME 项目名称

修改PROJECT_NAME项目的名称，比如这里修改为"Doxygen Project"，这个名称在说明书的首页和大部分页面里会被使用。

2. INPUT 源文件入口

INPUT指明需要生成说明书的代码源文件在哪里，比如这里是"…/src"，Doxygen就会在Doxyfile文件上一级目录下的src文件夹里去搜索。

3. RECURSIVE 递归查找

RECURSIVE这个tag默认是NO，如果代码源文件所在的文件夹有很多级目录，我们就需要递归的查找，这里设为YES。

4. FILE_PATTERNS 文件模版

FILE_PATTERNS里可以设置Doxygen查找的文件类型，过滤掉不需要的，这里根据不同的代码语言种类进行设置。

Step3：生成html文件夹

修改完Doxyfile后就可以直接在终端里输入：doxygen，回车后会默认生成一个名为html的文件夹，里面包含了很多html，png等文件，需要关注的是index.html文件。

Step4：在浏览器中打开说明书

最后我们就可以用浏览器打开这个index.html文件，欣赏生成的说明书。

firefox html/index.html