Doxygen配置文件
发布网友
发布时间：2024-10-23 18:53
共1个回答
热心网友
时间：2024-11-09 19:46
Doxygen的配置文件遵循Unix下常见的配置文件格式，以井号'#'开始注释，配置项由标签（tag）和值（value）组成，支持多值设置。配置内容分为输出选项和项目信息两部分。输出选项通常适用于多个项目，项目信息则需针对每个项目单独设定。
输出选项包括：
PROJECT_NAME：项目名称，定义项目的标识。
PROJECT_NUMBER：版本信息，可以用来区分不同版本的项目。
OUTPUT_DIRECTORY：指定文档生成的目录，可为相对路径或绝对路径。
INPUT：源代码目录或文件，使用空格分隔。
FILE_PATTERNS：指定输入目录中的特定文件类型，如.cpp和.h文件。
RECURSIVE：决定是否递归解析子目录。
EXCLUDE和EXCLUDE_PATTERNS：忽略输入目录中的特定子目录和文件。
OUTPUT_LANGUAGE：文档生成的语言，默认为英文，支持多种语言选项。
编码设置：默认根据操作系统选择。
EXTRACT_ALL：控制是否解析所有代码，包括无注释部分。
私有成员和静态项提取：通过EXTRACT_PRIVATE和EXTRACT_STATIC设置。
项目信息选项则有：
解析源文件中定义的类：EXTRACT_LOCAL_CLASSES。
源代码浏览器：SOURCE_BROWSER。
包含源代码：INLINE_SOURCES。
文档生成格式：如HTML、HTMLHELP、LATEX、RTF、MAN和XML，可按需开启。
每个选项都有详细的说明在配置文件中，可以根据项目需求灵活调整。
扩展资料
Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始，生成HTML格式的在线类浏览器，或离线的LATEX、RTF参考手册。
