使用doxygen生成注释文档——eclipse

因为工作需要，研究了几天doxygen的用法。心血来潮想着以博客的形式记录下来忘记的时候还能回顾哈~

前期准备：代码注释。

团队项目的话，方便起见也为了统一风格，建议直接导入配置信息文件，步骤如下：

Eclipse界面上，file->import->general->preferences，选择cqq.epf文件，finish。

完成操作以后，只要快捷键shift+Alt+j就可以在光标处自动生成注释信息，当然具体描述还是要自己写啦。

另外，要做一个小修改的是：回到Eclipse界面，Windows->Preferences->Java->CodeTemplates->Comments->Files,点击edit按钮，@author那里写上自己的大名哈。

PS：更多快捷键参考 Eclipse 快捷键指南。

-------------------------------华丽分割线-------------------------------------

好啦我们现在开始玩doxygen啦~~~~~~~~~

1.运行 doxygen-1.8.7-setup.exe ，安装 doxygen 。

2.将 eclox_0.8.0 、 eclox.update_0.8.0文件夹里的 features 和 plugins 的子文件分别复制到 Eclipse 安装路径下的 features 和 plugins 里面。

3.重启Eclipse

如图所示出现@就代表目前为止的操作成功。

4. Eclipse 中点击 Windows->Preferences->Doxygen，单击右边Add按钮添加doxygen安装目录下的bin 路径，如下图所示：

Ok保存设置。

5. Eclipse左边目录，选中一个项目右击，New->Other->Doxygen，点击next，finish。

6.回到Eclipse界面，双击项目目录下的.doxyfile文件（上一步操作中的产物），现提供三个方案进行相关配置：

①参考链接：http://blog.csdn.net/fym0121/article/details/7566427

            http://www.cnblogs.com/lanxuezaipiao/p/3551609.html

            http://hi.baidu.com/hailinzeng/item/670d242564256ccaa5275a87

②一个一个尝试生成最符合自己心意的产物。

③△推荐！！！直接复制 Readmifareclassic.doxyfile 内容替换你的.doxyfile文件的内容（注意改project 的name就OK）。

7.配置完成以后，还是回到Eclipse界面，点击上边的@按钮生成一下就好啦。现在你可以带些小兴奋的打开项目文件夹啦。

首先，普及一下知识，doxygen的输出格式主要有HTML、RTF、LaTeX。

•   Doxygen在输出HTML文档时，可以自动准备用于制作CHM的项目文件（.hhp）、目录文件（.hhc）和索引文件（.hhk）。

制作chm文件的方法：安装好htmlhelp.exe 以后双击hhw.exe， file->open，打开html路径下的index.hhp文件，点击

喝杯咖啡的时间html路径下一个index.chm文件华丽丽地现身了。

PS:如果得到的chm左边目录乱码了，把index.hhc另存为ANSI编码格式就好了。

• Doxygen输出的RTF格式，已经针对Word作了优化，可以较好地转换到Word文档。

• Doxygen在输出LATEX文档的同时准备了转换到pdf格式的makefile。只要系统安装了合适的TEX工具，就可以从LATEX文档生成pdf文档

。这里我准备的是WinEdt8.0。具体操作如下：

  安装好WinEdt.exe打开软件，file->open，打开latex路径下的refman.tex文件，点击

展开下拉列表选中PDFLaTeX，选中后点击按钮就OK了。

PS：如果输出台出现“!Package inputenc Error: Unicode char \u8:制 not set upfor use with LaTeX.”，将refman.tex的第一句\documentclass[twoside]{book}改成\documentclass[a4paper,UTF8]{ctexbook}再次点击PDFLaTeX就好啦~