1. doxygen是一个很方便的帮助文档的生成工具，类似于javadoc，但是比javadoc的适用面广，还可以作为代码浏览的工具来使用
2. 使用简单，几分钟学会，coding的时候注释是一个程序员必须做的事情，那么再熟悉一下doxygen的规则几乎不占用多少时间，几个简单的语法，能方便的帮助程序员展示成功，也方便他人阅读、学习你的代码
3. 几乎使用于所有的流行语言，只要是使用/**/注释的都可以使用
4. 可产生html和pdf等主流格式的文档

安装

略

代码注释风格

1. 用/** */添加一段注释，应用于函数或者类
2. 注释中可以使用html的标签
3. 记住几个常用的tag, @按uthor, @date, @param, @return, @see 即可满足日常需求， 不同语言有特别的特性，但是为了顾及效率，我们只需记住简单通用的

产生帮助文档

1. 到工作目录
2. 运行doxygen -g产生一个Doxfile， 按需修改Doxfile，修改以下几个参数即可工作
   1. OUTPUT_DIRECTORY 生成文档的存放目录
   2. INPUT 源文件目录
   3. EXTRACT_ALL抽取所有的注释，public/private
   4. SOURCE_BROWSER 是否在生成的帮助中能阅读源代码
   5. GENERATE_HTML YES生成html页面，也可生成chm和其它的格式，具体见手册
3. 运行 doxygen Doxfile即产生文档

reference

1. 详细帮助文档
2. 10分钟教程