用doxygen自动生成详细设计文档

以前写程序的时候就是从开始就是编码，调试通过了就算结束了。工作了以后这个规则就变了，先要写概要设计文档，再详细文档，再编码，再测试，再返工。。。。。。当后面测试返工调整的时候与以前设计的思路可能已经不一样了，这时再去修改文档感觉就没有动力了。所以就想了一招用doxygen来成生详细设计文档，这样在修改代码的时候，把注释修改一下，再生成就OK了，这样文档也可以跟着代码在更新。

doxygen的安装和基本操作步骤这里就不讲了，这里主要讲的东西是文档第一个页面怎么生成。对于这个问题我想了很多的办法，上网也查了很多，但还是找不到很好的办法，后来查了doxygen的帮助以后有了以下的办法。

首先在工程里面增加一个mainpage.h的文件，这个文件里面的内容如下：

/** @mainpage 首页
*<br/>
*<br/>
*<span style=”font-size: 26pt; font-family: 幼圆”>
*    <CENTER>********公司</CENTER>
*</span>
*<span style=”font-size: 18pt; font-family: 楷体_GB2312″>
*    <br/>
*    <CENTER>项目名</CENTER>
*    <br/>
*    <CENTER>目录监视</CENTER><br/>
*</span>
*<br/>
*<span style=”font-size: 24pt; font-family: 黑体”>
*    <CENTER>详细设计说明书</CENTER>
*    <br/>
*    <br/>
*</span>
*<br/>
*<span style=”font-size: 14pt; font-family: 黑体”>
*    <CENTER>****部门</CENTER>
*    <br/>
*    <CENTER>2009年 3月</CENTER><br/>
*</span>
*<br/>
*/

#ifndef _MAINPAGE_H_
#define _MAINPAGE_H_

#endif

然后在doxygen里面增加mainpage.h文件，再重新生成chm或是html文件，这样就可以在第一页看到这个页面了。

今天的文章用doxygen自动生成详细设计文档分享到此就结束了，感谢您的阅读，如果确实帮到您，您可以动动手指转发给其他人。