doxygen配置文件说明
doxygen注释规则
Doxygen注释规则1. 简介Doxygen是一种文档生成工具，能从源代码中提取结构、关系等信息，并生成API文档。
Doxygen可以对C、C++、Java、Python等语言的代码进行注释，帮助开发者理解复杂的代码结构和函数之间的关系。
本文档将详细介绍Doxygen的注释规则，以帮助开发者更有效的使用该工具。
2. 文件注释Doxygen支持在每个源文件中添加一个全局的文件注释。
这个注释会被Doxygen用来生成目录页。
格式如下：/*** @file example.cpp* @brief Example description* @author Your Name* @date Date of creation* @version V1.0* @brief This is a brief description of the file.*/3. 类和结构体注释对于类和结构体，Doxygen需要使用`@class`或`@struct`命令。
同时，也需要提供类的简短描述和详细描述。
格式如下：/*** @class MyClass* @brief A brief description of MyClass.* Detailed description...*/4. 类成员变量和函数注释对于类的成员变量和函数，Doxygen使用`@var`、`@member`、`@param`、`@return`等命令。
这些命令后面都需要接上描述信息。
格式如下：/*** @var int myVar This is a variable description.* @member void MyClass::myFunction() This is a function description.* @param int x This is a parameter description.* @return int This is a return value description.*/5. 特殊注释标签Doxygen还提供了一些特殊的注释标签，如`@todo`、`@bug`、`@deprecated`等，用于标记代码的特殊状态。
自动生成帮助文档工具——Doxygen的使用示例（C++）
⾃动⽣成帮助⽂档⼯具——Doxygen的使⽤⽰例（C++）在项⽬中⽤了Doxygen来制作⽂档，记录备忘。
查了不少⽂章，主要使⽤⽅法及例⼦参考都是来⾃以下链接：使⽤步骤：⼀、安装内容1 安装 Doxygen(Windows)2 安装 graphviz(Windows) 因为项⽬⽐较⼩所以没有安装graphviz3 安装 Windows Help Workshop 要⽣成 CHM 格式的⽂档需安装⼆、配置Doxygen1 写的代码注释很多都是中⽂的，如果源码是GB2312格式，记得转为UTF-8格式。
直接输⼊GB2312格式没有尝试。
2 Export Label 下的HTML选项中，CHM_INDEX_ENCODING选项要使⽤GB2312，否则⽣成的CHM中会显⽰乱码。
（实际上在使⽤CHM 中的搜索功能时仍存在乱码，未解决）3 记住要添加 hhc.exe 的路径。
三、代码⽰例此⽰例在链接⽰例基础上修改，简单的注释变量、函数、类等基本够⽤了。
注释应该还有⼀些其他的功能，有时间需要深⼊了解⼀下。
PS:例如想插⼊⼀些调⽤函数的⽰例代码。
.h/*** @file** 此⽂件⽤于定义class example**@auther ...*////定义EXAMPLE_OK的宏为0#define EXAMPLE_OK 0/*** @brief 类的简短说明** 此类⽤于doxygen的使⽤说明**/class Example {private:///变量var1int var1;public:///变量var2int var2;///变量var3int var3;void ExFunc1(void);void int ExFunc2(int a,char b);char *ExFunc3(char *c);}View Code.cpp/*** @file** 此⽂件⽤于定义example class 的 * member function** @author ...*//*** @brief ExFunc1 的简易说明** ExFunc1没有任何参数及返回值*/void Example::ExFunc1(void){//code}/*** @brief ExFunc2 的简易说明** ExFunc2()传回两个参数相加的值 ** @param a ⽤来相加的参数* @param b ⽤来相加的参数* @return 传回两个参数相加的结果 */int Example::ExFunc2(int a,int b){return(a+b);}/*** @brief ExFunc3的简易说明** ExFunc3()只传回参数输⼊的指标。
Doxygen常用配置
若CALLER_GRAPH，HAVE_DOT都为YES，doxygen将被每一个全局函数或类方法生成一个被调用的依赖图。
HIDE_UNDOC_RELATIONS
若为YES，如果目标未被文档化或者不是一个类，那么继承和协作图中将隐藏继承和调用的关系。
COLLABORATION_GRAPH
HIDE_SCOPE_NAMES
域隐藏，建议永远不要开启。
SHOW_INCLUDE_FILES
是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列表。
INLINE_INFO
如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。
SORT_MEMBER_DOCS
用于指定文档中包含一个或多个保存有dot文件的目录。
LATEX_OUTPUT
LaTeX文件的输出目录，与HTML_OUTPUT用法相同，一样是指在OUTPUT_DIRECTORY之下的路径。预设为latex。
LATEX_CMD_NAME
LaTeX程序的命令名称及档案所在。预设为latex。
RTF：
RTF_OUTPUT
与HTML_OUTPUT用法相同，用来指定RTF输出档案路径。预设为rtf。
GRAPHICAL_HIERARCHY
设置为YES时，将会绘制一个图形表示的类图结构。
UML_LOOK
若为YES，doxygen将生成继承和协作的图表，在样式类似于OMG的统一建模语言。
CALL_GRAPH
若CALL_GRAPH，HAVE_DOT都为YES，doxygen将被每一个全局函数或类方法生成一个调用依赖图。
GENERATE_CHI
Doxygen使用教程(个人总结)
简介Doxygen一．什么是Doxygen？Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。
通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注,与打捞铁达尼号同样的辛苦.大部分有用的批注都是属于针对函式,类别等等的说明。
所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担.不过,反过来说，整理文件的工作对于您来说，就是沉重的负担。
Doxygen 就是在您写批注时，稍微按照一些它所制订的规则。
接着,他就可以帮您产生出漂亮的文档了。
因此，Doxygen 的使用可分为两大部分。
首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生文档。
目前Doxygen可处理的程序语言包含：•C/C++•Java•IDL （Corba， Microsoft及KDE-DCOP类型)而可产生出来的文档格式有：•HTML•XML•LaTeX•RTF•Unix Man Page而其中还可衍生出不少其它格式。
HTML可以打包成CHM格式，而LaTeX可以透过一些工具产生出PS或是PDF文档。
二．安装Doxygen•1。
1 安装 Doxygen 1。
7。
4(Windows）•1。
2 安装 graphviz 2。
28。
0（Windows)graphviz 是一个由AT＆T实验室启动的开源工具包，用于绘制DOT语言脚本描述的图形.Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图，如不需要此功能可不安装该工具包。
•1。
3 安装 Windows Help Workshop 1。
32Doxygen 使用这个工具可以生成 CHM 格式的文档。
三．Doxygen的配置Doxygen 产生文档可以分为三个步骤.一是在程序代码中加上符合Doxygen所定义批注格式。
二是使用Doxywizard进行配置。
doxygen注释详解-附有生成文档的对照
使用Doxygen的目的. Doxygen所需工具. 配置Doxygen Doxygen注释风格
第一页，编辑于星期三：四点 五十六分。
使用Doxygen的目的
生成模块文档，方便以后维护模块代码。 提高代码可读性。 提高项目代码的管理。
省略了自己写readme文件（或文档）。
作符已经够我们函数用了，所以不再列举。） 特殊符号指令符：-、#、::。（这三符号对于我们也够用了）
第二十五页，编辑于星期三：四点 五十六分。
Param 指令操作符讲解
Param：指定函数参数指令操作符。 Param 格式如下：
@param 参数名 参数说明 @param [in] 参数名 参数说明
第八页，编辑于星期三：四点 五十六分。
附带操作
为了方便运行Doxygen工具与管理.为每个模块创建一文
件夹(如：“TEST”),在TEST文件夹里再创建src、doc文件夹。
Src文件夹存放源文件，doc文件夹存放Doxygen输出文件。
顺便把doxygenWD.bat和Doxygen配置文件“Doxyfile” 拷
第九页，编辑于星期三：四点 五十六分。
配置Doxygen
分为两种:
①向导(Wizard)模式：将快速配置大多数重要设定, 其他选项保持默认值。
②专家(Expert)模式：进入全部的配置选项。
第十页，编辑于星期三：四点 五十六分。
向导(Wizard)模式
向导(Wizard)对话框----Project相关选项
第二十八页，编辑于星期三：四点 五十六分。
note 指令操作符讲解
note：指定函数注意项事或重要的注解指令操作符。
note格式如下： @note 简要说明
doxygen标准VC注释_完整的配置步骤
C++ 程序文档生成器介绍(doxygen)程序文档，曾经是程序员的一个头痛问题。
写一个程序文档，比较花时间，但不是很难；麻烦的是当程序修改后，程序文档也要跟着同步更新，否则文档和程序就要脱节，文档也就变成没用的东西了。
好在有许多好用的文档生成器来解决这个问题。
目前比较流行的C++文档生成器是doxygen。
本文就简单的介绍一下doxygen的文档注释方法，以供初学者参考：1. 模块定义（单独显示一页）/** @defgroup 模块名模块的说明文字* @{*/... 定义的内容 .../** @} */ // 模块结尾2. 分组定义（在一页内分组显示）/** @name 分组说明文字* @{*/... 定义的内容 .../** @} */3. 变量、宏定义、类型定义简要说明/** 简要说明文字 */#define FLOAT float/** @brief 简要说明文字（在前面加 @brief 是标准格式） */#define MIN_UINT 0/** 分行的简要说明 \n* 这是第二行的简要说明*/int b;4. 函数说明/** 简要的函数说明文字* @param [in] param1 参数1说明* @param [out] param2 参数2说明* @return 返回值说明*/int func(int param1, int param2);/** 打开文件 \n* 文件打开成功后，必须使用 ::CloseFile 函数关闭。
* @param[in] file_name 文件名字符串* @param[in] file_mode 文件打开模式字符串，可以由以下几个模块组合而成：* - r 读取* - w 可写* - a 添加* - t 文本模式(不能与 b 联用)* - b 二进制模式(不能与 t 联用)* @return 返回文件编号* - -1 表示打开文件失败* @note 文件打开成功后，必须使用 ::CloseFile 函数关闭* @par 示例:* @code// 用文本只读方式打开文件int f = OpenFile("d:\\test.txt", "rt");* @endcode* @see ::ReadFile ::WriteFile ::CloseFile* @deprecated 由于特殊的原因，这个函数可能会在将来的版本中取消。
doxygen配置及使用手册
Doxygen安装及使用手册一简介Doxygen可以从C，C++，java等源代码中提取消息来生成帮助文档，API资料等二下载Doxygen以下，是在linux平台下的demo介绍。
http://www.stack.nl/~dimitri/doxygen/index.htmldoxyen主页去下载doxygen-1.5.5.src.tar.gz三 Doxygen安装安装doxygen-1.5.5.src.tar.gz1 把下载好的doxygen-1.5.5.src.tar.gz拷到自己想要的目录中，我放到了自己的Home目录下。
2 进入相应的目录：本例是在自己的home目录下3 解压#tar -zxvf doxygen-1.5.5.src.tar.gz会在当前目录下生成一个名字为doxygen-1.5.5的目录。
4 在自己的Home目录下建立一个doxygen目录，我们的doxygen以后就安装到这个目录下。
#mkdir doxygen5 进入doxygen-1.5.5目录#cd doxygen-1.5.56 安装：用—prefix选项制定安装目录为/home/lvq/doxygen，lvq为我的用户名，这里可以用~/doxygen代替。
#./configure –prefix ~/doxygen#make#make install这样在~/doxygen 目录就安装好了doxygen软件7 生成配置文件#cd ~/doxygen/bin/# ./doxygen –g 文件名执行这个命令后就会生成一个制定名字的配置文件，这里我们不加文件名，只用./doxygen –g 生成默认配置文件Doxyfile。
四如何使用DoxygenDoxygen可以从源代码中提取消息生成帮助文档，它是根据源代码中的特定注释来实现。
所以，首先要给工程代码书写符合Doxygen格式的注释。
1 以sipproxy小工程为例1)这个工程在/home/lvq/self/sipproxy1/sipproxy-v1.04/目录下。
LINUX下Doxygen的配置与使用
LINUX下Doxygen的配置与使⽤在⼤型程序中，对⾃⼰的程序有个良好的注释会读者阅读以及⾃⼰对程序的维护，尤其写个软件包的时候显得尤为重要。
别⼈推荐了Doxygen来对程序进⾏注释，⾃⼰⽤了下感觉很不错，推荐⼤家使⽤。
我⽤的系统是Ubuntu16.04,这⾥主要讲下在该系统下Doxygen的安装与配置，在其他Linux系统下都⼤同⼩异。
１. Doxygen的安装sudo apt-get install doxygensudo apt-get install graphviz其中graphviz是doxygen依赖的包，若不安装，使⽤doxygen的时候会报错。
2. DoxygenToolkit.vim插件配置1)下载DoxygenToolkit.vim 插件 打开该⽹址后，搜索DoxygenToolkit.vim，然后下载下来。
2) 将下载的⽂件DoxygenToolkit.vim放到vim的plugin ⽂件夹中 ⼀般linux的vim的plugin⽂件夹在/usr/share/vim/vim74/plugin下（我⽤的vim74)。
如果不在该⽂件夹下 ,利⽤sudo locate /plugin搜索即可得到。
3)修改vimrc⽂件 在vimrc⽂件最后加⼊如下命令： let g:DoxygenToolkit_briefTag_pre="@Synopsis "let g:DoxygenToolkit_paramTag_pre="@Param "let g:DoxygenToolkit_returnTag ="@Returns "let g:DoxygenToolkit_blockHeader="============================================================================"let g:DoxygenToolkit_blockFooter="============================================================================"let g:DoxygenToolkit_authorName="XIU"let g:DoxygenToolkit_fileTag = "@filename "其中：DoxygenToolkit_authorName="XIU" 根据⾃⼰的名字来进⾏修改。
doxygen文件配置
doxygen⽂件配置主要配置修改整个程序配置分⼏个部分1. Project related configuration options项⽬相关，包括：PROJECT_NAME（项⽬名）OUTPUT_DIRECTORY（输出⽬录）OUTPUT_LANGUAGE（输出语⾔）INLINE_INHERITED_MEMB（显⽰继承属性）是否对C、Java、Fortran等优化2. Build related configuration optionsEXTRACT_PRIVATE、EXTRACT_STATIC（显⽰私有、静态变量）SHOW_INCLUDE_FILES（显⽰ include ⽂件）SORT_BRIEF_DOCS（对brief descriptions重新排序）SHOW_FILES（显⽰⽂件）SHOW_NAMESPACES（显⽰作⽤域）3. Configuration options related to warning and progress messages4. Configuration options related to the input filesINPUT（源⽂件相对位置）INPUT_ENCODING（字符编码）IMAGE_PATH（图⽚位置）5. Configuration options related to source browsingSOURCE_BROWSER（显⽰源程序）6. Configuration options related to the alphabetical class index7. Configuration options related to the HTML output8. Configuration options related to the LaTeX output9. Configuration options related to the RTF output10. Configuration options related to the man page output11. Configuration options related to the XML output12. Configuration options related to the DOCBOOK output13. Configuration options for the AutoGen Definitions output14. Configuration options related to the Perl module output15. Configuration options related to the preprocessor16. Configuration options related to external references17. Configuration options related to the dot toolHAVE_DOT（使⽤dot）CALL_GRAPH（显⽰调⽤图）运⾏使⽤doxygen [Doxygen file]注释参考⾃。
DOXYGEN代码文档生成工具的使用
DOXYGEN代码文档生成工具的使用
一、Doxygen介绍
Doxygen是一种使用C++编写的自由、开源的文档编译器，用于基于
源代码的文档生成。
Doxygen可以用来生成多种不同的文档格式，如HTML、LaTeX、PDF、PostScript、Man和RTF，可以自带功能，同时可以输出各
种类图、流程图、以及无数其他图表来帮助说明意图和定义。
二、Doxygen使用
Doxygen的配置文件是一个可在配置文件中设置不同参数的文本文件。
用户可以在其中设置不同的文档输出格式、文件类型、源文件路径、源文
件编码格式、对表达式的评估等参数，以控制Doxygen的输出文档。
Doxygen可以根据代码中的注释来生成文档，因此，要想使用Doxygen生成文档，代码中需要有完整的注释，包括文件简介、变量注释、函数注释和类注释等。
Doxygen主要由以下几部分组成：
（1）标准文档：由Doxygen管理的文档，用户可以在其中添加自己
的文档。
（2）源文件：存放源代码的文件夹，以及文件。
doxygen使用方法
doxygen使用方法Doxygen是一个开源工具，用于生成软件项目的文档。
它可以解析源代码中的注释，然后生成相应的文档，包括类、函数、变量、文件等的说明，以及函数的调用图、继承图等。
本文将详细介绍Doxygen的使用方法。
一、安装Doxygen二、配置Doxygen在使用Doxygen生成文档之前，需要进行一些配置。
Doxygen的配置文件为'Doxyfile'，通过修改这个文件来定制Doxygen的行为。
1.在项目根目录下，使用以下命令生成默认的配置文件：``````一些常用的参数如下：-PROJECT_NAME：项目的名称，会显示在生成的文档中。
-INPUT：需要生成文档的源文件或目录。
通常设置为代码文件所在的目录，以及一些额外的源文件。
-OUTPUT_DIRECTORY：文档的输出目录。
-RECURSIVE：是否递归处理子目录。
-FILE_PATTERNS：需要处理的源文件的模式。
可以使用通配符指定多个文件类型。
-EXCLUDE：需要排除的文件或目录。
3.保存修改后的配置文件。
4.使用以下命令来生成文档：``````5. 生成的文档将存储在指定的输出目录中。
打开'index.html'文件即可浏览生成的文档。
三、编写注释为了让Doxygen能够正确解析源代码中的注释并生成相应的文档，我们需要按照一定的规则编写注释。
下面是一些常用的注释标记和使用方法。
1.文件注释```/***...*/```2.命名空间注释```/***...namespace namespace_name//...```3.类注释```/***...*/class class_name//...```4.函数注释```/***...*/return_type function_name(param_type param_name) //...四、生成高级文档特性Doxygen还支持生成一些高级的文档特性，如调用图、继承图等。
doxygen文档注释简介
Details.
*/
int (*handler)(int a,int b);
};
如果配置文件中JAVADOC_AUTOBRIEF 设置成 YES，可以使用JavaDoc风格注释
/**
* A test class. A more elaborate class description.
/*! Details. */
*enumPtr,//! Enum variable.
/*! Details. */
enumVar; //! A constructor.
/*!
A more elaborate description of the constructor.
/** 简要说明.
* 详细说明.
*/
多行C++风格注释：
/// 简要说明.
/// 详细说明.
3、可以采用如下注释：
/// 简要说明.
/** 详细说明. */
或者
//! 简要说明.
//! 详细 （上面的空行是需要的）
//! 说明.
上例中间空行用来分隔简要说明和详细说明的。请注意下面格式的注释是不合法的，doxygen只允许一条详细说明对应一条简要说明：
* @param a an integer argument.
* @param s a constant character pointer.
* @see Test() testMeToo()
/**
* A constructor.
* A more elaborate description of the constructor.
强大的Doxygen工具使用手册（中文帮助）
强⼤的Doxygen⼯具使⽤⼿册（中⽂帮助）张三：假如我们⾃⼰开发了⼀个类库，怎么做⼀个⽅便阅读的⽂档呢？李四：⼀个⽅法⼀个⽅法地写呗，就像写Excel⽂档⼀下。
张三：啊，你out了，这多慢呀。
为什么不玩玩doxygen⼯具，它能帮你⽣成⽂档？李四：这么爽，什么东东，给说讲讲。
1. Doxygen, what？Doxgen就是⼤名⿍⿍的⽂档⽣成⼯具，⽽且是免费开源的，它使⽤⾮常⽅便，能提取C++，Java，Objective-C，Python，IDL，PHP，C#等语⾔的注释，从⽽⽣成⽂档。
你可以访问其官⽅⽹站，下载安装包，它的官⽹上有详细的使⽤⼿册。
⽀持的主要语⾔格式Extension Language.idl IDL.ddl IDL.odl IDL.java Java.cs C#.c C.cpp C++可产⽣出来的⽂档格式有：HTMLXMLLaTeXRTFCHM要让⼯具能提取注释，那么就要求你写的注释要按照⼀定的规则来写，不能乱写，不然该⼯具是⽆法识别的，通常在Java中，只要JavaDoc能识别的，doxgen也能识别。
2. 安装Doxygen我们可以在这个⽹址去下载最新的安装包安装过程就不⽤说了，很简单，直接Next，最后Finish就OK了。
3. 配置Doxygen配置doxgen是最核⼼的，你可以设置你要提取注释的源⽂件，⽣成的⽂档格式，⼯程名称，⽂档的Logo等信息，这些配置是可以存储起来的，当你的源代码更新后，重新再运⾏这个配置⽂件，就可以重新⽣成⼀个新的⽂档。
在安装后，进⼊到其安装⽬录下的bin⽂件夹，它⾥⾯有两个⽂件：doxygen.exe和doxywizard.exe，我们先运⾏doxywizard.exe来进⾏配置，从⽽⽣成配置⽂件（如果是第⼀次运⾏）。
图1，Doxygen配置主界⾯。
1，Doxygen⼯作⽬录，就是⽤来存储配置⽂件的⽬录。
2，递归搜索⽬录需要选上。
图2，选择输出⽂档格式图3，⽣成类图图4，选择⽂档的编码格式。
doxygen生成源码文档
doxygen⽣成源码⽂档使⽤doxygen ⽣成源代码的⽂档是相当⽅便的，本⽂就简单整理下doxygen的使⽤说明1. 安装 关于安装的问题不做特殊的说明，这⾥直接使⽤命令安装，源码安装不做介绍ubuntu: sudo apt-get install doxygencentossudo yum install doxygen2. 配置⽂件配置 关于doxygen主要的部分就在于配置⽂件的配置， doxygen相当强⼤，所以配置⽂件内容有点多。
这⾥只介绍⼀部分，⼤家有兴趣可以继续深⼊研究 (1) 重要标记 配置⽂件采⽤ <TAGNAME> = <VALUE> 这样的结构，与 Make ⽂件格式相似。
下⾯是最重要的标记： <OUTPUT_DIRECTORY>：必须在这⾥提供⼀个⽬录名，例如 /home/user1/documentation，这个⽬录是放置⽣成的⽂档⽂件的位置。
如果提供⼀个不存在的⽬录名，doxygen 会以这个名称创建具有适当⽤户权限的⽬录。
<INPUT>：这个标记创建⼀个以空格分隔的所有⽬录的列表，这个列表包含需要⽣成⽂档的 C/C++ 源代码⽂件和头⽂件。
例如，请考虑以下代码⽚段： INPUT = /home/user1/project/kernel /home/user1/project/memory 在这⾥，doxygen 会从这两个⽬录读取 C/C++ 源代码。
如果项⽬只有⼀个源代码根⽬录，其中有多个⼦⽬录，那么只需指定根⽬录并把<RECURSIVE> 标记设置为 Yes。
<FILE_PATTERNS>：在默认情况下，doxygen 会搜索具有典型 C/C++ 扩展名的⽂件，⽐如.c、.cc、.cpp、.h和.hpp。
如果<FILE_PATTERNS> 标记没有相关联的值，doxygen 就会这样做。
doxygen的使用说明
Doxygen的使用说明一、安装Doxygen所需工具经我安装测试推荐如下软件版本：注：HTML Help Workshop工具要安装在这个路径“X:\Program Files\HTML Help Workshop”（X：自己指定）。
二、附带操作为了方便运行Doxygen工具与管理，为每个模块创建一文件夹，我将此文件夹命名为Test，在Test文件夹里再创建src和doc文件夹。
Src文件夹主要存放源文件，doc文件夹主要放置Doxygen输出文件。
注：Doxygen不支持中文路径，所以路径中不要出现中文字符。
三、配置DoxygenDoxygen中有很多详细的功能，很多是不需要的，因为我们接触的一般是C++和C所以我主要介绍Doxygen关于此两个方面的用法。
相关详细的配置教程网上有很多也很容易，所以这里就不再赘述，如下文件doxygen-1.8.6-setup\Test\doc\Doxyfile是我的一个配置文件，可以直接放到Test文件下的doc文件里，用户只需打开这个配置文件就完成了Doxygen的配置。
如果只为C和C++做注释时，只需修修改如下内容即可。
首先打开Doxygen，如下图所示：单击File项选择open，选择你将Doxyfile配置文件所放的路径，找到doxyfile配置文件，然后打开，你的Doxygen就完成了基本的配置，不过有几处需要修改，下面我详细介绍下：Project name:项目名称，将作为所生成的程序文档首页标题Project version or id:文档版本号和可对应项目版本号Source code directory:存放要生成项目文档的项目源文件路径，推荐放到已建立的Src文件里Destination directory：生成文档输出路径，我设置的是输出到桌面的output文件夹里，推荐放到已建立的doc文件夹里。
单击Mode选项，如图所示：如果只用到C++则不需改动，如用到其它语言则选择相应的选项。
Doxygen配置(翻译)-ASP教程,ASP应用
使用doxygen文档开发工具时需要进行的配置：可执行文件doxygen 是原代码分析和生成文档的主要工具. 请看doxygen usage 章节来获取更详细的使用帮助.doxytag可执行文件---仅仅是用来实现帮助程序员生成不需要看原代码就能了解工程部署信息的doxygen文档的参考文档( 例如：那些使用doxygen生成的文档).请看doxytag usage 章节来获得更多的使用帮助.doxywizard 可执行文件很容易就能使用,它是用来为doxygen工具提供配置信息的一个图形化工具.下面的图显示了开发工具之间的相互关系信息:http://www.stack.nl/~dimitri/doxygen/infoflow.gif图：doxygen information flowstep 1: 创建一个配置文件doxygen使用一个配置文件来确定它所有的设置. 每个工程都应该有它自己的配置文件.一个工程可以只有一个原文件, 也可以是工程中所有原文件的递归扫描得到的原文件的树状视图。
为了简化doxygen生成配置文件的工作, doxygen 可以为你提供一个模板化的配置文件.1. 为了创建一个模板化的配置文件，只需要调用doxygen并从命令行中敲入-g:doxygen -g <config-file>其中<config-file>是某个模板化的配置文件的文件名. 如果你省略了文件名, doxygen会为你生成一个默认的doxyfile的配置文件. 如果<config-file>是一个已经存在的文件名, doxygen 在生成配置模板之前，将会生成一个<config-file>. bak 备份文件。
2. 如果你使用- (例如：减号) 作为文件名doxygen将会把你从键盘输入的文字当作配置文件名。
配置文件有着和makefile相似的格式.主要是：包含了很多的“标志”分配符格式(tags):例如：tagname = value ortagname = value1 value2 ...在生成文档模板时，你可以使用默认（即：保留大多数的tags）详细信息请看configuration 这一章节来获取更多的信息.如果你不想使用文本编辑工具来编写配置文件,你应该看看doxywizard 章节的描述, 它是一个可以用来创建/读/写doxygen 配置文档的图形化工具，同时它也可以在路径中进行全路径配置来使doxygen正常工作。
doxygen配置说明
∙ABBREVIATE_BRIEF //简短摘要∙ALIASES //别名∙ALLEXTERNALS //所有外部文档∙ALPHABETICAL_INDEX //字母顺序索引∙ALWAYS_DETAILED_SEC //详细描述部分∙BINARY_TOC //二进制操作∙BRIEF_MEMBER_DESC //简短的成员描述∙CALL_GRAPH //调用到的图∙CASE_SENSE_NAMES //检测的范例的名字∙CHM_FILE //CHM格式文件∙CLASS_DIAGRAMS //类-表∙CLASS_GRAPH //类-图∙COLLABORATION_GRAPH //相互调用关系图∙COLS_IN_ALPHA_INDEX //以列形式显示的字母顺序的索引∙COMPACT_LATEX //压缩的LATEX文档∙COMPACT_R TF //压缩的RTF文档∙CREATE_SUBDIRS //创建一个"子目录"∙DETAILS_AT_TOP //文档的详细头部∙DIRECTORY_GRAPH //目录图∙DISABLE_INDEX //禁用INDEX∙DISTRIBUTE_GROUP_DOC //禁用文档成组显示∙DOT_IMAGE_FORMAT //点阵图形∙DOT_MULTI_TARGETS //多个DOT目标∙DOT_PATH //DOT路径设置∙DOT_TRANSPARENT //DOT转换设置∙DOTFILE_DIRS //DOTFILE 列表显示∙ENABLE_PREPROCESSING //允许"预处理"指令∙ENUM_VALUES_PER_LINE //每行的枚举值∙ENABLED_SECTIONS //允许分段显示∙EXAMPLE_PATH //例子路径∙EXAMPLE_PATTERNS //例子用的文件格式（*.cpp, *.h , *.java等）∙EXAMPLE_RECURSIVE //例子递归∙EXCLUDE //可执行文件∙EXCLUDE_PATTERNS //可执行文件格式（*.exe, *.dll等）∙EXCLUDE_SYMLINKS //可执行的SYMLINKS∙EXPAND_AS_DEFINED //规定的扩展∙EXPAND_ONLY_PREDEF //预定义扩展∙EXTERNAL_GROUPS //使用到的外部的文件∙EXTRA_PACKAGES //使用到的外部插件包∙EXTRACT_ALL //提取所有∙EXTRACT_LOCAL_CLASSES //提取所有本地类∙EXTRACT_LOCAL_METHODS //提取所有本地方法∙EXTRACT_PRIVATE //提取所有private∙EXTRACT_STATIC //提取所有stati c∙FILE_PATTERNS //文件路径∙FILE_VERSION_FILTER //文件版本控制∙FILTER_PATTERNS //控制格式（主版本：第1次版本：第2次版本号）∙FILTER_SOURCE_FILES //原文件的版本控制∙FULL_PATH_NAMES //全路径名∙GENERATE_AUTOGEN_DEF //生成自动定义文件形式∙GENERATE_BUGLIST //生成BUG列表∙GENERATE_CHI //生成"希腊字母" ∙GENERATE_DEPRECIATEDLIST //生成"评估"列表∙GENERATE_HTML //生成HTML∙GENERATE_HTMLHELP //生成HTMLHELP ∙GENERATE_LATEX //生成LATEX∙GENERATE_LEGEND //生成图例∙GENERATE_MAN //生成MAN文件∙GENERATE_PERLMOD //生成Perl脚本∙GENERATE_RTF //生成RTF∙GENERATE_TAGFILE //生成标志文件∙GENERATE_TESTLIST //生成TESTLIST∙GENERATE_TODOLIST //生成TODOLIST ∙GENERATE_TREEVIEW //生成树状视图显示∙GENERATE_XML //生成XML∙GRAPHICAL_HIERARCHY //继承图表∙GROUP_GRAPHS //组-图∙HAVE_DOT //隐藏DOT∙HHC_LOCATION //隐藏位置∙HIDE_FRIEND_COMPOUNDS //隐藏"复合的"友员类型∙HIDE_IN_BODY_DOCS //隐藏文档的主体∙HIDE_SCOPE_NAMES //隐藏"作用域"名∙HIDE_UNDOC_CLASSES //隐藏"未归档"的所有CLASS ∙HIDE_UNDOC_MEMBERS //隐藏"未归档"的所有的成员∙HIDE_UNDOC_RELATIONS //隐藏"未归档"的关系∙HTML_ALIGN_MEMBERS //H TML文档中成员对齐方式∙HTML_FOOTER //H TML脚注设置∙HTML_HEADER //HTML头部设置∙HTML_OUTPUT //H TML输出设置∙HTML_STYLESHEET //H TML样式设置∙IGNORE_PREFIX //忽略哪些前缀∙IMAGE_PATH //图片的路径设置∙INCLUDE_GRAPH //包含-图∙INCLUDE_PATH //头文件包含的路径∙INHERIT_DOCS //文档的继承关系∙INLINE_INFO //内联信息∙INLINE_INHERITED_MEMB //通过"继承"得到的内联成员∙INLINE_SOURCES //内联部分的源代码∙INPUT //输入设置∙INPUT_FILTER //能够接受的输入文件的扩展名格式设置（重要）∙INTERNAL_DOCS //内部文档∙JAVADOC_AUTOBRIEF //JAVADOC工具生成的文档的"自动摘要"∙LATEX_BATCHMODE //LATEX匹配方式∙LATEX_CMD_NAME //LATEX 命令名∙LATEX_HEADER //LATEX 头部∙LATEX_HIDE_INDICES //LATEX内部隐藏的包含∙LATEX_OUTPUT //LATEX输出∙MACRO_EXPANSION //宏展开设置（重要）∙MAKEINDEX_CMD_NAME //MAKEINDEX命令索引∙MAN_EXTENSION //MAN扩展∙MAN_LINKS //MAN链接设置∙MAN_OUTPUT //MAN输出设置∙MAX_DOT_GRAPH_DEPTH //DOT图的最大深度∙MAX_DOT_GRAPH_HEIGHT //DOT图的最大高度∙MAX_DOT_GRAPH_WIDTH //DOT图的最大宽度∙MAX_INITIALIZER_LINES //最大初始化行∙MULTILINE_CPP_IS_BRIEF //多个CPP文件的简短描述∙OPTIMIZE_OUTPUT_FOR_C //对C采用的优化设置∙OPTIMIZE_OUTPUT_JAVA //对JAVA采用的优化设置∙OUTPUT_DIRECTORY //输出路径设置（重要）∙OUTPUT_LANGUAGE //输出语言设置（重要）∙PAPER_TYPE //纸张类型∙PDF_HYPERLINKS //PDF格式超链接设置（重要）∙PERL_PATH //perl路径设置∙PERLMOD_LATEX //perlm od LATEX∙PERLMOD_PRETTY // perlm od PRETTY（漂亮/相当）∙PERLMOD_MAKEVAR_PREFIX //perlm od MAKE文件版本PREFIX ∙PREDEFINED //预先定义（重要）∙PROJECT_NAME //工程名（重要）∙PROJECT_NUMBER //工程的组成成员（重要）∙QUIET //静态量设置（重要）∙RECURSIVE //递归和循环∙REFERENCED_BY_RELATION //交叉参考（重要）∙REFERENCES_RELATION //交叉参考的关系∙REPEAT_BRIEF //重新设置"简短说明"为打开状态∙RTF_EXTENSIONS_FILE //RTF展开文件∙RTF_H YPERLINKS //RTF超链接∙RTF_OUTPUT //RTF输出设置∙RTF_STYLESHEET_FILE //RTF样式文件∙SEARCH_INCLUDES //搜索时需要包含什么（重要）∙SEARCHENGINE //搜索引擎设定（重要）∙SHORT_NAMES //使短文件名生效∙SHOW_DIRECTORIES //显示目录∙SHOW_INCLUDE_FILES //显示包含文件（一般NO，否则太大）∙SHOW_USED_FILES //显示被用到的文件（一般YES）∙SKIP_FUNCTION_MACROS //跳过函数中的宏（重要），菜鸟最好别跳∙SORT_BRIEF_DOCS //文档的简短摘要∙SORT_MEMBER_DOCS //成员的简短描述∙SOURCE_BROWSER //原文件浏览路径∙STRIP_CODE_COMMENTS //排除哪些条码形式注释（重要）∙STRIP_FROM_INC_PATH //排除哪些头文件包含的注释（重要）∙STRIP_FROM_PATH //排除哪些条码路径设置∙SUBGROUPING //子组设置（重要）∙TAB_SIZE //TAB符SIZE设置（重要）∙TAGFILES //标志文件∙TEMPLATE_RELATIONS //模板关系设置（重要）∙TOC_EXPAND //TOC扩展∙TREEVIEW_WIDTH //树状图显示的宽度设置（重要）∙UML_LOOK //UML外观设置（重要）∙USE_WINDOWS_ENCODING //使用windows系统的编码形式（重要）∙VERBATIM_HEADERS //VERBATIM头部（头文件）∙WARN_FORMAT //警告格式指定（重要）∙WARN_IF_DOC_ERROR //如果文档出错则显示警告∙WARN_IF_UNDOCUMENTED //如果是未归档文件则显示警告∙WARN_LOGFILE //警告日志文件设置∙WARN_NO_PARAMDOC //无参数文档警告形式设定∙WARNINGS //警告设置（重要）∙XML_DTD //XML文件类型定义（重要）∙XML_OUTPUT //XML输出设置（重要）∙XML_PROGRAMLISTING //XML程序列表（重要）∙XML_SCHEMA //XML模式设置（重要）。
doxygen讲解文档
Doxygen讲解文档为代码写注释一直是大多数程序员有些困扰的事情。
当前程序员都能接受为了程序的可维护性、可读性编码的同时写注释的说法，但对哪些地方应该写注释，注释如何写，写多少等这些问题，很多程序员仍然没有答案。
更头痛的是写文档，以及维护文档的问题，开发人员通常可以忍受编写或者改动代码时编写或者修改对应的注释，但之后需要修正相应的文档却比较困难。
如果能从注释直接转化成文档，对开发人员无疑是一种福音。
而doxygen 就能把遵守某种格式的注释自动转化为对应的文档。
Doxygen是基于GPL的开源项目，是一个非常优秀的文档系统，当前支持在大多数unix（包括linux），windows家族，Mac系统上运行，完全支持C++, C, Java, IDL（Corba 和Microsoft 家族）语言，部分支持PHP和C#语言，输出格式包括HTML、latex、RTF、ps、PDF、压缩的HTML和unix manpage。
有很多开源项目（包括前两篇文章介绍的log4cpp 和CppUnit）都使用了doxygen文档系统。
而国内的开发人员却使用的不多，这里从开发人员使用的角度介绍这个工具，使开发人员用最少的代价尽快掌握这种技术，并结合这个工具探讨如何撰写注释的问题。
以下以linux下的C++语言为例进行介绍，以下讨论基于doxygen1.3.3。
样式表文件Orignl_doxygen.css、green_doxygen.css、yellow_doxygen.css、Blue_doxygen.css，改文件名为doxygen.css后，拷贝到生成html文档的目录内可以改变文档显示的样式。
1. doxygen使用步骤由于只是工具的使用，这里不介绍它的原理，直接从使用步骤开始。
Doxygen的使用步骤非常简单。
主要可以分为：1）第一次使用需要安装doxygen的程序doxygen的安装非常简单，linux下可以直接下载安装包运行即可，下载源代码编译安装也是比较通用的编译安装命令。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
# 文档版本号，可对应于项目版本号，譬如 svn、cvs 所生成的项目版本号
PROJECT_NUMBER = "1.0.0"
# 程序文档输出目录,产生的文件会放在这个路径之下。如果没有填这个路径，将会以目前所在路径作为输出路径
TYPEDEF_HIDES_STRUCT = YES
# 在 C++ 程序文名字空间这样的概念，所以此处设置为 YES
HIDE_SCOPE_NAMES = YES
# 让 doxygen 静悄悄地为你生成文档，只有出现警告或错误时，才在终端输出提示信息
QUIET = YES
#指定加载或找寻要处理的程序代码文件路径。这边是一个表列式的型态。并且可指定档案及路径
INPUT = src
# 如果INPUT Tag 中指定了目录,可以透过这个Tag来要求Doxygen在处理时，只针对特定的档案进行动作。例如：希望对目录下的扩展名为.c, .cpp及.h的档
# 在程序文档中允许以图例形式显示函数调用关系，前提是你已经安装了 graphviz 软件包
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
#案作处理。可设定FILE_PATTERNS = *.c, *.cpp, *.h
FILE_PATTERNS = *.c\
*.h
#是否允许源程序在程序文档中产生
SOURCE_BROWSER = YES
# 递归遍历当前目录的子目录，寻找被文档化的程序源文件
RECURSIVE = YES
# 允许程序文档中显示本文档化的函数相互调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文档
GENERATE_LATEX = NO
#Doxygen文件的编码方式，默认为UTF-8，若希望支持中文，最好设置为 GB2312
DOXYFILE_ENCODING = GB2312
#Project的版本号
PROJECT_VERSION = 1.0
# 项目名称，将作为于所生成的程序文档首页标题, Project 的名字，以一个单词为主，多个单词请使用双引号括住
# 示例程序目录
EXAMPLE_PATH = example/
# 示例程序的头文档 (.h 文件) 与实现文档 (.c 文件) 都作为程序文档化对象
EXAMPLE_PATTERNS = *.c\
*.h
# 递归遍历示例程序目录的子目录，寻找被文档化的程序源文件
EXAMPLE_RECURSIVE = YES
OUTPUT_DIRECTORY = doc/
# 程序文档语言环境,默认为English
OUTPUT_LANGUAGE = Chinese
# 如果是制作 C 程序文档，该选项必须设为 YES，否则默认生成 C++ 文档格式
OPTIMIZE_OUTPUT_FOR_C = YES
# 对于使用 typedef 定义的结构体、枚举、联合等数据类型，只按照 typedef 定义的类型名进行文档化