利用Doxygen生成C++、Java文档

示例程序、配置文件及doxygen常见参数文字版参见本文附件

先来看下生成html格式的文档：


1、下载&安装
http://www.stack.nl/~dimitri/doxygen/download.html
下载完了双击安装，你懂的

2、生成并修改配置文件
如下命令将在当前目录下生成一个 “Doxygen.config”的配置文件；配置文件基本是通用的，只是工程名什么的需要适当修改

doxygen -g Doxygen.config

3、修改配置文件
当你生成的文档中中文全是乱码，不知你会作何感想？于是乎，配置文件还是得自己动手改改的！

配置文件就是一文本，如下图所示：

各种选项啊！！！以下挑出来一些进行了修改（重要的用红色标出），修改时请善用编辑器的查找选项~


4、生成文档
命令行下的一句命令而已：

doxygen Doxygen.config

也可以在visual studio中配置外部工具如下（假设配置文件在solution的doc目录下）：


5、文档规范
有前置注释和后置注释两种，其中后置注释放在变量后面，要在开头加一个<号。
示例如下（详尽的注释规范参见最后给出的官方文档链接）：

#pragma once //就是示例代码，我也忘不了你啊
/**
*@file 
*@brief 文件的简介，必须以英文句点结尾.
*该文件的详细介绍。  每个文件都应该有这种文件介绍，否则该文件注释居然就是代码。。。其他注释也被省略了
*/


/**类的简明注释以英文句号结尾.
* 我是类的详细注释啊详细注释
*/
class ExampleForDoxygen {

    int size;///< 放在变量后面的简明注释，注意需要一个小于号表示注释是后置注释

public:

    ///方法的简明注释，出现在方法列表中
    int getSize();

    ///方法简明注释，方法2：
    /**方法详细注释，只出现在方法的具体介绍中*/
    static inline int getLeftChildIndex (int index /**<[in]参数注释也可以后置哦，用方块内的in表明是输入参数*/,int outParm /**<[out]输出参数*/,int index /**<[inout]输出输出参数*/);
    
    /** 简明注释以英文句号结尾.  我是详细注释啊详细注释
    *@param index [in]参数注释,这种方法下写in貌似不行啊
    *@return 返回值注释
    *@see getLeftChildIndex   //参见列表
    */   
    static inline int getParentIndex (int index) ;
};

6、其他链接
注释规范官方文档（更全）： http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
文档中可用的特殊命令（@param之类的）： http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdsee
文档中嵌入html代码： http://www.stack.nl/~dimitri/doxygen/manual/htmlcmds.html
主页上显示说明： http://www.stack.nl/~dimitri/doxygen/manual/faq.html