Doxygen是代码描述的文档系统。开源,跨平台,类似JavaDoc。完全支持:C、C++、Java、Objective-C和IDL语
Doxgen可以生成:HTML,Latex,RTF等格式文档。同时支持数学公式的生成。
可自动生成的包含依赖图(include dependency
支持平台:Linux,Unix,Windows
需要注意的是doxygen并不处理所有的注释,doxygen重点关注与程序结构有关的注释,比如:文件、类、结构、函数、变量、宏等注释,而忽略函数内变量、代码等的注释。
Doxygen执行时,需要一个配置文件。它随身携带了一个DoxyWizard,可以用来方便的配置。
DoxyWizard分成三部分:
【Wizard】:配置项目的基本信息。
【Expert】:详细的配置信息。
【Load】:可以直接加载一个已编写好的配置文件。
【Expert】:只解释个人认为比较实用的设置。随时可能更新。
Project:主要包括项目的基本配置。
TAB_SIZE:帮助文件中,代码缩进尺寸。建议按照代码习惯设置。(例如我设置为4)
OPTIMIZE_OUTPUT_FOR_C:是否将描述性文字,以C为标准。如果是C代码,建议选择。
SUBGROUPING:暂未理解含义(转载LZ认为此设置比较重要)。
Build:比较关键的配置页面。
EXTRACT_ALL:输出所有函数。但private和static函数不受此属性管制。
EXTRACT_PRIVATE:
EXTRACT_STATIC:
HIDE_UNDOC_MEMBERS:没有使用Doxygen格式描述的文档不生成。但,使用EXTRACT_ALL,则此属性无效。
INTERNAL_DOCS:输出注解中的@internal部分。
CASE_SENSE_NAMES:是否使用全部小写来标注名称。对C/C++等大小写敏感语言,不能使用。
SHOW_INCLUDE_FILES:是否显示包含文件。开启,则会生成一个页面,用来显示所有包含文件列表。(建议自己尝试效果后再决定是否使用)
SORT_MEMBER_DOCS:开:,按照函数名字母排序。关:按照解释顺序排序。
SHOW_USED_FILES:是否在函数和类帮助文件下,显示其来源文件。
SHOW_FILES:是否现实文件列表页面。
Messages:设置编译时的输出信息选项。主要用来提醒一些输入的语法错误。
QUIET:是否关闭编译时的输出信息。