DOxygen for C++使用说明——注释代码二

这一次我在谷歌搜索中检索到了Doxygen在github的仓库，进去一看，令人大喜，github仓库里含有了一个Doxygen的官方配置文件Doxyfile,于是下载下来，发现Doxyfile已经配置了将仓库中的\src文件编译成Documentation,并且将结果放在了doxygen_docs里面。如下图所示：

接着我们可以一边查看源代码，一边查看效果HTML，很快就可以熟悉Doxygen操作了。

我这里罗列了一些比较常用的用法。

• 排版 

    关于排版，有两种格式比较常用，分别如下：

 

以上两种方式都有出现，不过我个人比较喜欢第二种。

那怎么设置，会出现这两种不同的效果呢？答案很简单，在【Output】中选取HTML格式时，若选择【with navigation panel】,则为第二种效果，否则为第一种效果，如下：

• 在生成的文档中附加源代码

如果不勾选以上选项，则在最后生成的文档中只有.h文件而没有.cpp等文件。

• 添加源文档，我们在前面的【Wizard】---->【Project】,已经填写了源代码路径，不过那个路径只有一个，如果你需要多个，可以在这里添加。

• 添加必要的源代码路径，有些文件不会出现在最终的说明文档中，但对我们要input的文档是必要的，所以需要添加上相应的路径。