对于我们的软件代码来说，不但要自己读得懂，而且要让其他人能很快的了解的这些代码的主要功能，便于其他工程师进行代码维护。另一方面，对于项目经理来说，他可能不会去直接读你的代码，更多的是你需要提供一个代码说明文档给他，如何写一份规范的代码说明文档？这里我给大家简单介绍一下非常不错的工具Doxgen，大家照着下面的方法做就能得到一份规范的代码文档。
 
前提：
1. 假设你已经创建了test.h, test.c连个代码文件
2. 你会使用vim
 
需要下载的东东：
1. http://www.vim.org/scripts/script.php?script_id=987， 去这里下载doxygen针对vim的插件，并且拷贝到~/.vim/plugin/中去.
2. 安装doxygen以及其UI，sudo apt-get install doxygen doxywizard
 
更改你的注释
1. 用vim打开你的代码，在你的代码文件开始处，输入vim命令: DoxAuthor，然后根据提示输入作者姓名，版本号等，这样，在文档开始处会自动加上这些信息
2. 在作者信息后面输入命令:DoxLic，这样会生成默认的GPL版本说明
3. 在代码的函数名处输入:Dox，这样可以在函数前面自动生成函数说明
4. 使用/** ...*/这种风格来注释代码内容，比如：
     /** Add x with y*/
     z = x + y;
5.如果要注释前面的代码，使用/**< ...*/这种形式, 比如：
    z = x + y; /**< Add x with y*/
 
使用doxywizard来生成文档：
1. 在linux终端输入 doxywizard来打开doxygen的UI见面
2. 在Setp1: Configuration doxygen中点击Wizard打开doxywizard界面，在里面输入工程名字，版本号，并且选择源文件路径，文档输出路径，并且可以选择代码编程语言，比如c/c+/java等
3.点击ok退回主界面，在Setp2中点击Save
4. Setp3中选择执行doxygen的路径
5. Setp4中点击Start，之后就可以在你指定的路径中找到生成的程序文档了！
 
以上就是Doxygen最简单的教程，当然了，Doxygen是一个非常强大的工具，还有其他非常多的功能，希望大家在以后的使用中慢慢体会！