Ubuntu18.04 使用doxygen生成注释文档

       在程序开发的过程中，经常遇到的是与别人交接程序，直接看别人代码是很头疼的一件事情，更何况现在有一些人写的程序非常的烂，几百行一个的函数，瞎起名字的变量，简直是代码自带加密功能，对人非常不友好。
       本人以前的公司，要求的比较严格，系统设计详细设计各种文档都是比较全的，设计完成后再写代码，给别人解释程序的时候，将详细设计文档发给别人就可以了。可以避免直接看代码的问题。在现在的工作时遇到的问题就是开发的周期非常短，提出需求来就马上要功能，根本没有设计一说，时间长了搞得非常难受，尤其多人参与一个模块的项目。
       下面分享一下使用doxygen生成注释文档的方式。一是毕竟没有要求的情况下，大家都很懒，不愿意写设计文档。二是省时间，通过注释生成文档，给别人交接的时候非常方便，显得自己也更专业。从管理者的角度看，有说明文档的程序，在多人协作的项目中帮助非常大，更甚在现在这种人员流动大的背景下。留下文档真的很有必要。
       废话说一堆，下面说一下如何做。首先我用的系统是ubuntu。如果大家是在windows下开发的话，只会比我这个简单。
       首先，使用的vscode作为开发工作，好处是有自带的注释生成插件，生成注释都很容易。
如下图，安装Doxygen Documentation Generator插件。从扩展商店里搜索Doxygen就能找到。



       这个插件使用后特别方便的是输入/**回车就能自动生成注释。在头文件的开发输入/**就会生成头文件注释，在函数上面输入/**回车就能生成函数注释。如下所示,这个就非常方便了，写注释也方便，都只是顺手的事情了。:



       且不说后面有没有设计文档，单纯就是风格统一的注释，让人看起来心情就会非常舒服。
代码都加上注释后，就是如何生成文档。windows下就不说了，安装doxygen软件就行。
ubuntu下执行下面命令安装doxygen图形界面：

sudo apt-get install doxygen doxygen-gui

安装完成终端输入doxywizard,后打开gui面板

$doxywizard

打开图形界面后下面几个位置根据自己工程实际情况输入即可。


上面输入完成后，点【Run】面板，点按钮[Run Doxygen]即可在指定目录生成。

最后进入指定的生成目录找到index.html文件，用网页打开就可以看了，风格非常nice的说明文档。

       这里特别说明一下的是，在ubuntu上没有办法生成chm的文档。因为这个是windows的格式。如果是windows的话，就可以选择生成chm的文档了。在linux下只能生成html的形式了。