doxygen配置说明
doxygen 参数类型

doxygen 参数类型摘要:1.Doxygen 简介2.Doxygen 参数类型概述3.Doxygen 参数类型的分类4.常见Doxygen 参数类型介绍5.Doxygen 参数类型的使用示例6.总结正文:【1.Doxygen 简介】Doxygen 是一个用于从源代码中生成文档的工具,特别适用于C、C++ 和Java 等编程语言。
它可以自动提取代码中的类、函数、变量等信息,并生成结构清晰、易于理解的文档。
在编写项目文档时,利用Doxygen 可以大大提高效率。
【2.Doxygen 参数类型概述】Doxygen 参数类型指的是在生成文档过程中,Doxygen 可以识别的变量、函数、类等元素的类型。
通过指定不同的参数类型,可以控制Doxygen 如何处理这些元素,以及在生成的文档中如何呈现。
【3.Doxygen 参数类型的分类】Doxygen 参数类型主要分为以下几类:- 变量类型(如:int、float、double 等)- 函数类型(如:void、int、void 等)- 类类型(如:class、struct 等)- 枚举类型(如:enum 等)- 宏类型(如:#define、#ifdef 等)【4.常见Doxygen 参数类型介绍】以下是一些常见的Doxygen 参数类型及其介绍:- `int`: 整型变量或函数返回值类型- `float`: 浮点型变量或函数返回值类型- `double`: 双精度浮点型变量或函数返回值类型- `void`: 函数无返回值类型,或表示某个变量没有值- `char`: 字符型变量或函数返回值类型- `const`: 常量类型,表示不可修改的变量或函数参数- `volatile`: 表示变量的值可能会被其他线程修改- `static`: 表示静态变量或函数,仅在定义它的源文件中有效- `class`: 表示一个类,包含类的成员变量和成员函数- `struct`: 表示一个结构体,包含结构体的成员变量和成员函数- `enum`: 表示一个枚举类型,包含一组有名字的常量- `#define`: 表示一个预处理器宏,用于定义常量或条件编译- `#ifdef`: 表示一个预处理器指令,用于检查某个宏是否已定义【5.Doxygen 参数类型的使用示例】以下是一个简单的Doxygen 参数类型使用示例:```c++/*** @file example.cpp* @brief 示例文件*//*** @class Example* @brief 示例类*/class Example {public:/*** @brief 示例类的构造函数*/Example();/*** @brief 示例类的析构函数*/~Example();/*** @brief 示例类的成员函数* @param int value 传入的整数值* @return int 返回的整数值*/int add(int value);};Example::Example() {/*** @brief 示例类的构造函数实现*/}Example::~Example() {/*** @brief 示例类的析构函数实现*/}int Example::add(int value) {/*** @brief 示例类的成员函数实现* @return int 返回的整数值*/return value + 1;}```在上述示例中,`Example` 类是一个示例类,包含一个构造函数、一个析构函数和一个成员函数。
Doxygen中文使用

Doxygen中⽂使⽤Doxygen中⽂使⽤以下对Doxygen的使⽤分为三个部分:⼀.⽣成基本的中⽂注释⽂档;⼆.添加函数关系调⽤图;三.⽣成全中⽂的chm⽂档。
⼀.⽣成基本的中⽂注释⽂档:(⼀) Wizard(1) Wizard->ProjectProject name:⽣成的Doxygen注释⽂档的名称;Project synopsis:⽣成的Doxygen注释⽂档的简介;Project version or id:注释⽂档版本号;Project logo:⽂档图标;Source code directory:代码路径,也就是需要⽣成注释⽂档的代码所在的⽂件夹;Destination directory:⽣成的注释⽂档存放的地⽅。
(2) Wizard->Mode若勾选上Include cross-referenced source code in output,则⽣成的Doxygen⽂档会包含相应头⽂件的源代码。
(3) Wizard->Outputplain HTML:⽣成平铺形式的页⾯;with navigation panel:⽣成带有左侧导航栏形式的页⾯;prepare for compressed HTML(.chm):准备⽣成chm⽂件。
(4) Wizard->Diagrams若不⽣成函数调⽤关系图,默认即可。
(⼆) Expert(1) Expert->Project在OUTPUT_LANGUAGE⼀栏中选择输出语⾔为Chinese。
(2) Expert->Input在INPUT_ENCODING⼀栏中,输⼊GB2312,这样对⽂档的注释才⽀持中⽂,否则中⽂注释将会是乱码。
在完成上诉配置后,在Run选项卡中点击Run doxygen,即可⽣成能够⽀持中⽂注释的⽂档。
⼆.填加函数关系调⽤图:(⼀) Expert->Dot勾选HAVE_DOT、CALL_GRAPH、CALLER_GRAPH选项,并在DOT_PATH中添加graphviz安装⽬录下的bin⽂件夹。
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配置文件说明

# 文档版本号,可对应于项目版本号,譬如 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
linux vscode doxygen documentation generator 用法

linux vscode doxygen documentation generator 用法要在Linux上使用VSCode和Doxygen生成文档,您需要按照以下步骤进行操作:安装VSCode:首先,您需要在Linux上安装Visual Studio Code。
您可以从VSCode 官网下载适用于Linux的安装程序,并按照说明进行安装。
安装Doxygen:Doxygen是一个用于生成代码文档的工具。
您可以使用包管理器来安装Doxygen。
例如,在Ubuntu上,您可以使用以下命令安装Doxygen:sqlsudo apt-get install doxygen安装Doxygen插件:在VSCode中,您需要安装Doxygen插件来支持Doxygen文档生成。
打开VSCode,进入扩展商店,搜索Doxygen并安装它。
配置Doxygen:在VSCode中打开您的项目文件夹,并打开名为"Doxyfile"的文件(如果不存在,您可以创建一个)。
在Doxyfile中,您可以配置Doxygen的选项,例如输出格式、目录结构和生成器类型等。
生成文档:配置完成后,打开终端并导航到项目文件夹。
运行以下命令来生成文档:cssdoxygen Doxyfile这将根据Doxyfile中的配置生成文档。
6. 查看文档:生成的文档将保存在指定的输出目录中。
您可以在浏览器中打开生成的HTML文件来查看文档。
请注意,以上步骤是一般性的指导,具体细节可能因您的项目和配置而有所不同。
确保仔细阅读Doxygen和VSCode的文档,并根据您的需求进行适当的配置和调整。
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标准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 由于特殊的原因,这个函数可能会在将来的版本中取消。
LINUX下Doxygen的配置与使用
LINUX下Doxygen的配置与使⽤在⼤型程序中,对⾃⼰的程序有个良好的注释会读者阅读以及⾃⼰对程序的维护,尤其写个软件包的时候显得尤为重要。
别⼈推荐了Doxygen来对程序进⾏注释,⾃⼰⽤了下感觉很不错,推荐⼤家使⽤。
我⽤的系统是Ubuntu16.04,这⾥主要讲下在该系统下Doxygen的安装与配置,在其他Linux系统下都⼤同⼩异。
1. 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)源文件:存放源代码的文件夹,以及文件。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
∙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模式设置(重要)。