使用doxygen生成注释文档——visual studio

前期准备：代码注释。

这里介绍两个方法：

一．安装插件

1. 安装GhostDoc插件。（建议设置快捷键为shift+Alt+j）

2. 回到vs界面规范注释规则。

Tools->GhostDoc->ConfigureGhostDoc->Rules->Classes->Default documentation，Edit修改配置信息：

@Description (用一句话描述该文件做什么)

@author Indexcqq 

 @date $(Environment.Date)

 @version V1.00

3. 设置头文件注释信息：找到你的vs安装目录，比如我的是D:\QMDownload\MySoftwares\VS2008\Common7\IDE，打开IDE文件夹，点击右上角的搜索，搜索Class.cs文件，把里面所有的文件都在头部加上如下注释说明，这样每次添加类文件时就会自动添加如下的头注释。（同理对其他文件像Program.cs、form.cs、Form.Designer.cs做修改也可以实现这样的效果。）

//-------------------------------------------------------------

// <copyright file="$safeitemname$.cs"company="FK">

//     Copyright (c) 2016FK. All rights reserved.

// </copyright>

// <summary>The main entrypoint class.</summary >

// <history>

//     <versionnumber="1.00" date="$time$" creater="Indexcqq"></version>

// </history>

//-------------------------------------------------------------

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

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

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

2.运行Doxywizard.exe.现提供三个方案进行相关配置：

①参考链接：

            http://blog.csdn.net/axlrosek/article/details/1557692

http://blog.csdn.net/fym0121/article/details/7566427

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

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

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

③△推荐！！！打开Doxywizard.exe，File->Open，选中CSharpDemo.doxyfile打开，修改project 的name和project源码路径就OK啦。

7.配置完成以后， run->run doxygen。

首先，普及一下知识，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编码格式就好了。

    ②如果遇到chm右边内容是 “此程序无法显示网页”的情况，考虑文件路径有#符号，把#去掉就成功显示啦~

• 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就好啦~

另外，找到{\large 制作者 Doxygen 1.8.7} 这一句改成 {\large 制作者 Indexcqq（同学们写自己的大名哈）}