doxygen 注释规范_自用的C++代码Doxygen注释规范（一）

Doxygen是目前流行的一种文档生成工具，对于自身查阅、团队合作、与人交流代码都有积极作用。为了统一、规范使用，特此整理以下方式来编写doxygen注释，此规范用于我自己的C++代码编写中。

在我的软件项目中，doxygen的相关注释与文档被视为源代码的一部分，并不是可有可无的，而是必须有。我学习使用doxygen的时间还很短，还有很多不足之处，敬请谅解。这篇博客的内容很可能会经常进行修改，所以如果你看到的是转载的，最好还是来CSDN陆巍的博客(https://blog.csdn.net/weixin_44420912 )看原文。

1、安装doxygen

这里只介绍如何在Ubuntu下安装，其他操作系统下的安装请去官方网站查询。Ubuntu下安装很简单，只需两个命令：

sudo apt install doxygen

sudo apt install doxygen-gui

在Ubuntu 16.04下，用上述方式安装的doxygen版本是1.8.11，需要最新版本的朋友可以去官网 (Doxygen官网)下载安装。在写这份博客时，doxygen最新的版本是1.8.15。官网中有详细的说明文档可供在线查阅或下载观看。

通常我使用doxywizard命令来打开向导程序。在向导程序中可以保存配置方案，下次使用时用“doxywizard 配置文件”即可打开配置好的方案。

2、Doxygen向导配置时的注意事项

通过观察doxygen向导上的文字说明，基本上就能上手，这里提示一些可能会忽略的事情。

1)在首页“Project”设置中，最好勾选“Scan recursively”选项，意思就是递归扫描，除非项目中