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

[color=red][size=large]示例程序、配置文件及doxygen常见参数文字版参见本文附件[/size][/color]

[size=large]先来看下生成html格式的文档：[/size]
[img]http://dl.iteye.com/upload/attachment/0082/7937/4b0c10ef-e7bc-3ee5-92cf-5318ada1935f.png[/img]

[size=x-large][color=blue]1、下载&安装[/color][/size]
[url]http://www.stack.nl/~dimitri/doxygen/download.html[/url]
[size=large]下载完了双击安装，你懂的[/size]

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

doxygen -g Doxygen.config

[size=x-large][color=blue]3、修改配置文件[/color][/size]
[size=large]当你生成的文档中中文全是乱码，不知你会作何感想？于是乎，配置文件还是得自己动手改改的！

配置文件就是一文本，如下图所示：[/size]
[img]http://dl.iteye.com/upload/attachment/0082/7877/44440ffb-4993-36a2-821e-6790feeb62ae.png[/img]
[size=large]各种选项啊！！！以下挑出来一些进行了修改（重要的用红色标出），修改时请善用编辑器的查找选项~[/size]
[img]http://dl.iteye.com/upload/attachment/0082/7887/32db14e9-ad77-315f-9e63-2c5ec0d91a30.png[/img]

[size=x-large][color=blue]4、生成文档[/color][/size]
[size=large]命令行下的一句命令而已：[/size]

doxygen Doxygen.config

[size=large]也可以在visual studio中配置外部工具如下（假设配置文件在solution的doc目录下）：[/size]
[img]http://dl.iteye.com/upload/attachment/0082/7928/7713a1a8-dee4-3f32-909e-201606220d3d.png[/img]

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

#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) ;
};

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